diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 000000000..4ae6d55fa --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,29 @@ +# This workflow will build a Java project with Maven +# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven + +name: Java CI with Maven + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up JDK 17 + uses: actions/setup-java@v2 + with: + java-version: '17' + distribution: 'adopt' + - name: Build with Maven + run: mvn -B package --file pom.xml + env: + GITHUB_ACTIONS: true + WHATSAPP_STORE: ${{ secrets.WHATSAPP_STORE }} + WHATSAPP_KEYS: ${{ secrets.WHATSAPP_KEYS }} + WHATSAPP_CONTACT: ${{ secrets.WHATSAPP_CONTACT }} + GPG_PASSWORD: ${{ secrets.GPG_PASSWORD }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..de4b15720 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target/ +.test/ diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 000000000..26d33521a --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/.idea/CobaltStreamline.iml b/.idea/CobaltStreamline.iml new file mode 100644 index 000000000..6c0de7d44 --- /dev/null +++ b/.idea/CobaltStreamline.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/compiler.xml b/.idea/compiler.xml new file mode 100644 index 000000000..065b63688 --- /dev/null +++ b/.idea/compiler.xml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/encodings.xml b/.idea/encodings.xml new file mode 100644 index 000000000..bed2401b8 --- /dev/null +++ b/.idea/encodings.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/.idea/jarRepositories.xml b/.idea/jarRepositories.xml new file mode 100644 index 000000000..9e7977a8a --- /dev/null +++ b/.idea/jarRepositories.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 000000000..52d397754 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,13 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/uiDesigner.xml b/.idea/uiDesigner.xml new file mode 100644 index 000000000..2b63946d5 --- /dev/null +++ b/.idea/uiDesigner.xml @@ -0,0 +1,124 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 000000000..35eb1ddfb --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.mvn/wrapper/maven-wrapper.jar b/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 000000000..cb28b0e37 Binary files /dev/null and b/.mvn/wrapper/maven-wrapper.jar differ diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 000000000..6d3a56651 --- /dev/null +++ b/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.3/apache-maven-3.9.3-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..ab140bb7c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Alessandro Autiero + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 000000000..1a736ea19 --- /dev/null +++ b/README.md @@ -0,0 +1,1108 @@ +# Cobalt + +Whatsapp4j has been renamed to Cobalt to comply with an official request coming from Whatsapp. +The repository's history was cleared to comply with this request, but keep in mind that the project has been actively developed for over two years. +To be clear, this library is not affiliated with Whatsapp LLC in any way. +This is a personal project that I maintain in my free time + +### What is Cobalt + +Cobalt is a library built to interact with Whatsapp. +It can be used with: +1. Whatsapp Web (Companion) +2. Whatsapp Mobile (Personal and Business) + +### Donations + +If you like my work, you can become a sponsor here on GitHub or tip me through: +- [Paypal](https://www.paypal.me/AutiesDevelopment). +- ERC20 address: 0xA7842cDb100fb91718961153149C86e4F4030a76 +- TRC20 address: THiutwmP7GFEz28tLB3k5ivoyTnxrteKoH + +I can also work on sponsored features and/or projects! + +### Java version + +This library was built for [Java 21](https://openjdk.java.net/projects/jdk/21/), the latest LTS. + +### Breaking changes policy + +Until the library doesn't reach release 1.0, there will be major breaking changes between each release. +This is needed to finalize the design of the API. +After this milestone, breaking changes will be present only in major releases. + +### Optimizing memory usage + +If the machine you are hosting this library on has memory constraints, please look into how to tune a JVM. +The easiest thing you can do is use the -Xmx argument to specify the maximum size, in bytes, of the memory allocation pool. +I have written this disclaimer because many new devs tend to get confused by Java's opportunistic memory allocation. + +### Can this library get my device banned? + +While there is no risk in using this library with your main account, keep in mind that Whatsapp has anti-spam measures for their web client. +If you add a participant from a brand-new number to a group, it will most likely get you banned. +If you compile the library yourself, don't run the CI on a brand-new number, or it will get banned for spamming too many requests(the CI has to test that all the library works). +In short, if you use this library without a malicious intent, you will never get banned. + +### How to install + +#### Maven + + - Dependency + ```xml + + com.github.auties00 + cobalt + 0.0.4 + + ``` + + - Annotation processor (required for @RegisterListener) + ```xml + + org.apache.maven.plugins + maven-compiler-plugin + + + + com.github.auties00 + cobalt + 0.0.4 + + + + + ``` + +#### Gradle + +- Groovy DSL + - Dependency + ```groovy + implementation 'com.github.auties00:cobalt:0.0.4' + ``` + + - Annotation processor (required for @RegisterListener) + ```groovy + annotationProcessor 'com.github.auties00:cobalt:0.0.4' + ``` + +- Kotlin DSL + - Dependency + ```groovy + implementation("com.github.auties00:cobalt:0.0.4") + ``` + + - Annotation processor (required for @RegisterListener) + ```groovy + annotationProcessor("com.github.auties00:cobalt:0.0.4") + ``` + +### Javadocs & Documentation + +Javadocs for Whatsapp4j are available [here](https://www.javadoc.io/doc/com.github.auties00/whatsappweb4j/latest/whatsapp4j/index.html). +The documentation for this project reaches most of the publicly available APIs(i.e. public members in exported packages), but sometimes the Javadoc may be incomplete +or some methods could be absent from the project's README. If you find any of the latter, know that even small contributions are welcomed! + +### How to contribute + +As of today, no additional configuration or artifact building is needed to edit this project. +I recommend using the latest version of IntelliJ, though any other IDE should work. +If you are not familiar with git, follow these short tutorials in order: + +1. [Fork this project](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) +2. [Clone the new repo](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) +3. [Create a new branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/managing-branches#creating-a-branch) +4. Once you have implemented the new + feature, [create a new merge request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) + +If you are trying to implement a feature that is present on WhatsappWeb's WebClient, for example audio or video calls, +consider using [CobaltAnalyzer](https://github.com/Auties00/CobaltAnalyzer), a tool I built for this exact purpose. + +### Disclaimer about async operations +This library heavily depends on async operations using the CompletableFuture construct. +Remember to handle them as your application will terminate without doing anything if the main thread is not executing any task. +Please do not open redundant issues on GitHub because of this. + +### How to create a connection +
+ Detailed Walkthrough + + +To create a new connection, start by creating a builder with the api you need: +- Web + ```java + Whatsapp.webBuilder() + ``` +- Mobile + ```java + Whatsapp.mobileBuilder() + ``` +If you want to use a custom serializer, specify it: + ```java + .serializer(new CustomControllerSerializer()) + ``` +Now select the type of connection that you need: +- Create a fresh connection + ```java + .newConnection(someUuid) + ``` +- Retrieve a connection by id if available, otherwise create a new one + ```java + .newConnection(someUuid) + ``` +- Retrieve a connection by phone number if available, otherwise create a new one + ```java + .newConnection(phoneNumber) + ``` +- Retrieve a connection by an alias if available, otherwise create a new one + ```java + .newConnection(alias) + ``` +- Retrieve a connection by id if available, otherwise returns an empty Optional + ```java + .newOptionalConnection(someUuid) + ``` +- Retrieve the first connection that was serialized if available, otherwise create a new one + ```java + .firstConnection() + ``` +- Retrieve the first connection that was serialized if available, otherwise returns an empty Optional + ```java + .firstOptionalConnection() + ``` +- Retrieve the last connection that was serialized if available, otherwise create a new one + ```java + .lastConnection() + ``` +- Retrieve the last connection that was serialized if available, otherwise returns an empty Optional + ```java + .lastOptionalConnection() + ``` +You can now customize the API with these options: +- name - The device's name for Whatsapp Web, the push name for Whatsapp's Mobile + ```java + .name("Some Custom Name :)") + ``` +- version - The version of Whatsapp to use + ```java + .version(new Version("x.xx.xx")) + ``` +- autodetectListeners - Whether listeners annotated with `@RegisterListener` should automatically be registered + ```java + .autodetectListeners(true) + ``` +- textPreviewSetting - Whether a media preview should be generated for text messages containing links + ```java + .textPreviewSetting(TextPreviewSetting.ENABLED_WITH_INFERENCE) + ``` +- checkPatchMacs - Whether patch macs coming from app state pulls should be validated + ```java + .checkPatchMacs(checkPatchMacs) + ``` +- proxy - The proxy to use for the socket connection + ```java + .proxy(someProxy) + ``` + +There are also platform specific options: +1. Web + - historyLength: The amount of messages to sync from the companion device + ```java + .historyLength(WebHistoryLength.THREE_MONTHS) + ``` +2. Mobile + - device: the device you want to fake: + ```java + .device(CompanionDevice.android(false)) // Standard Android + .device(CompanionDevice.android(true)) //Business android + .device(CompanionDevice.ios(false)) // Standard iOS + .device(CompanionDevice.ios(true)) // Business iOS + .device(CompanionDevice.kaiOs()) // Standard KaiOS + ``` + - businessCategory: the category of your business account + ```java + .businessCategory(new BusinessCategory(id, name)) + ``` + - businessEmail: the email of your business account + ```java + .businessEmail("email@domanin.com") + ``` + - businessWebsite: the website of your business account + ```java + .businessWebsite("https://google.com") + ``` + - businessDescription: the description of your business account + ```java + .businessDescription("A nice description") + ``` + - businessLatitude: the latitude of your business account + ```java + .businessLatitude(37.386051) + ``` + - businessLongitude: the longitude of your business account + ```java + .businessLongitude(-122.083855) + ``` + - businessAddress: the address of your business account + ```java + .businessAddress("1600 Amphitheatre Pkwy, Mountain View") + ``` + +> **_IMPORTANT:_** All options are serialized: there is no need to specify them again when deserializing an existing session + +Finally select the registration status of your session: +- Creates a new registered session: this means that the QR code was already scanned / the OTP was already sent to Whatsapp + ```java + .registered() + ``` +- Creates a new unregistered session: this means that the QR code wasn't scanned / the OTP wasn't sent to the companion's phone via SMS/Call/OTP + + If you are using the Web API, you can either register via QR code: + ```java + .unregistered(QrHandler.toTerminal()) + ``` + or with a pairing code(new feature): + ```java + .unregistered(yourPhoneNumberWithCountryCode, PairingCodeHandler.toTerminal()) + ``` + Otherwise, if you are using the mobile API, you can decide if you want to receive an SMS, a call or an OTP: + ```java + .verificationCodeMethod(VerificationCodeMethod.SMS) + ``` + Then provide a supplier for that verification method: + ```java + .verificationCodeSupplier(() -> yourAsyncOrSyncLogic()) + ``` + Finally, register: + ```java + .register(yourPhoneNumberWithCountryCode) + ``` + +Now you can connect to your session: + ```java + .connect() + ``` +to connect to Whatsapp. +Remember to handle the result using, for example, `join` to await the connection's result. +
+ +
+ Web QR Pairing Example + + ```java + Whatsapp.webBuilder() // Use the Web api + .lastConnection() // Deserialize the last connection, or create a new one if it doesn't exist + .unregistered(QrHandler.toTerminal()) // Print the QR to the terminal + .addLoggedInListener(api -> System.out.printf("Connected: %s%n", api.store().privacySettings())) // Print a message when connected + .addDisconnectedListener(reason -> System.out.printf("Disconnected: %s%n", reason)) // Print a message when disconnected + .addNewChatMessageListener(message -> System.out.printf("New message: %s%n", message.toJson())) // Print a message when a new chat message arrives + .connect() // Connect to Whatsapp asynchronously + .join(); // Await the result + ``` +
+ +
+ Web Pairing Code Example + + ```java + System.out.println("Enter the phone number(include the country code prefix, but no +, spaces or parenthesis):") + var scanner = new Scanner(System.in); + var phoneNumber = scanner.nextLong(); + Whatsapp.webBuilder() // Use the Web api + .lastConnection() // Deserialize the last connection, or create a new one if it doesn't exist + .unregistered(phoneNumber, PairingCodeHandler.toTerminal()) // Print the pairing code to the terminal + .addLoggedInListener(api -> System.out.printf("Connected: %s%n", api.store().privacySettings())) // Print a message when connected + .addDisconnectedListener(reason -> System.out.printf("Disconnected: %s%n", reason)) // Print a message when disconnected + .addNewChatMessageListener(message -> System.out.printf("New message: %s%n", message.toJson())) // Print a message when a new chat message arrives + .connect() // Connect to Whatsapp asynchronously + .join(); // Await the result + ``` +
+ +
+ Mobile Example + + ```java + System.out.println("Enter the phone number(include the country code prefix, but no +, spaces or parenthesis):") + var scanner = new Scanner(System.in); + var phoneNumber = scanner.nextLong(); + Whatsapp.mobileBuilder() // Use the Mobile api + .lastConnection() // Deserialize the last connection, or create a new one if it doesn't exist + .device(CompanionDevice.ios(false)) // Use a non-business iOS account + .unregistered() // If the connection was just created, it needs to be registered + .verificationCodeMethod(VerificationCodeMethod.SMS) // If the connection was just created, send an SMS OTP + .verificationCodeSupplier(() -> { // Called when the OTP needs to be sent to Whatsapp + System.out.println("Enter OTP: "); + var scanner = new Scanner(System.in); + return scanner.nextLine(); + }) + .register(phoneNumber) // Register the phone number asynchronously, if necessary + .join() // Await the result + .addLoggedInListener(api -> System.out.printf("Connected: %s%n", api.store().privacySettings())) // Print a message when connected + .addDisconnectedListener(reason -> System.out.printf("Disconnected: %s%n", reason)) // Print a message when disconnected + .addNewChatMessageListener(message -> System.out.printf("New message: %s%n", message.toJson())) // Print a message when a new chat message arrives + .connect() // Connect to Whatsapp asynchronously + .join(); // Await the result + ``` +
+ +### How to close a connection + +There are three ways to close a connection: + +1. Disconnect + + ```java + api.disconnect(); + ``` + > **_IMPORTANT:_** The session remains valid for future uses + +2. Reconnect + + ```java + api.reconnect(); + ``` + > **_IMPORTANT:_** The session remains valid for future uses + +3. Log out + + ```java + api.logout(); + ``` + > **_IMPORTANT:_** The session doesn't remain valid for future uses + +### What is a listener and how to register it + +Listeners are crucial to handle events related to Whatsapp and implement logic for your application. +Listeners can be used either as: + +1. Standalone concrete implementation + + If your application is complex enough, + it's preferable to divide your listeners' logic across multiple specialized classes. + To create a new concrete listener, declare a class or record that implements the Listener interface: + + ```java + import it.auties.whatsapp.listener.Listener; + + public class MyListener implements Listener { + @Override + public void onLoggedIn() { + System.out.println("Hello :)"); + } + } + ``` + + Remember to manually register this listener: + + ```java + api.addListener(new MyListener()); + ``` + + Or to register it automatically using the `@RegisterListener` annotation: + + ```java + import it.auties.whatsapp.listener.RegisterListener; + import it.auties.whatsapp.listener.Listener; + + @RegisterListener // Automatically registers this listener + public class MyListener implements Listener { + @Override + public void onLoggedIn() { + System.out.println("Hello :)"); + } + } + ``` + + Listeners often need access to the Whatsapp instance that registered them to, for example, send messages. + If your listener is marked with @RegisterListener and a single argument constructor that takes a Whatsapp instance as a parameter exists, + the latter can be injected automatically, regardless of if your implementation uses a class or a record. + Records, though, are usually more elegant: + + ```java + import it.auties.whatsapp.listener.RegisterListener; + import it.auties.whatsapp.api.Whatsapp; + import it.auties.whatsapp.listener.Listener; + + @RegisterListener // Automatically registers this listener + public record MyListener(Whatsapp api) implements Listener { // A non-null whatsapp instance is injected + @Override + public void onLoggedIn() { + System.out.println("Hello :)"); + } + } + ``` + + > **_IMPORTANT:_** @RegisterListener will only work if you register the annotation processor provided by Cobalt + +2. Functional interface + + If your application is very simple or only requires this library in small operations, + it's preferable to add a listener using a lambda instead of using full-fledged classes. + To declare a new functional listener, call the method add followed by the name of the listener that you want to implement without the on suffix: + ```java + api.addDisconnectedListener(reason -> System.out.println("Goodbye: " + reason)); + ``` + + All lambda listeners can access the instance of `Whatsapp` that called them: + ```java + api.addDisconnectedListener((whatsapp, reason) -> System.out.println("Goodbye: " + reason)); + ``` + + This is extremely useful if you want to implement a functionality for your application in a compact manner: + ```java + Whatsapp.newConnection() + .addLoggedInListener(() -> System.out.println("Connected")) + .addNewMessageListener((whatsapp, info) -> whatsapp.sendMessage(info.chatJid(), "Automatic answer", info)) + .connect() + .join(); + ``` + +### How to handle serialization + +In the original version of WhatsappWeb, chats, contacts and messages could be queried at any from Whatsapp's servers. +The multi-device implementation, instead, sends all of this information progressively when the connection is initialized for the first time and doesn't allow any subsequent queries to access the latter. +In practice, this means that this data needs to be serialized somewhere. +The same is true for the mobile api. + +By default, this library serializes data regarding a session at `$HOME/.whatsapp4j/[web|mobile]/`. +The data is stored in gzipped .smile files to reduce disk usage. + +If your application needs to serialize data in a different way, for example in a database create a custom implementation of ControllerSerializer. +Then make sure to specify your implementation in the `Whatsapp` builder. +This is explained in the "How to create a connection" section. + +### How to handle session disconnects + +When the session is closed, the onDisconnect method in any listener is invoked. +These are the three reasons that can cause a disconnect: + +1. DISCONNECTED + + A normal disconnection. + This doesn't indicate any error being thrown. + +2. RECONNECT + + The client is being disconnected but only to reopen the connection. + This always happens when the QR is first scanned for example. + +3. LOGGED_OUT + + The client was logged out by itself or by its companion. + By default, no error is thrown if this happens, though this behaviour can be changed easily: + ```java + import it.auties.whatsapp.api.DisconnectReason; + import it.auties.whatsapp.listener.Listener; + + class ThrowOnLogOut implements Listener { + @Override + public void onDisconnected(DisconnectReason reason) { + if (reason != SocketEvent.LOGGED_OUT) { + return; + } + + throw new RuntimeException("Hey, I was logged off :/"); + } + } + ``` + +### How to query chats, contacts, messages and status + +Access the store associated with a connection by calling the store method: +```java +var store = api.store(); +``` + +> **_IMPORTANT:_** When your program first starts up, these fields will be empty. For each type of data, an event is +> fired and listenable using a WhatsappListener + +You can access all the chats that are in memory: + +```java +var chats = store.chats(); +``` + +Or the contacts: + +```java +var contacts = store.contacts(); +``` + +Or even the status: + +```java +var status = store.status(); +``` + +Data can also be easily queried by using these methods: + +- Chats + - Query a chat by its jid + ```java + var chat = store.findChatByJid(jid); + ``` + - Query a chat by its name + ```java + var chat = store.findChatByName(name); + ``` + - Query a chat by a message inside it + ```java + var chat = store.findChatByMessage(message); + ``` + - Query all chats that match a name + ```java + var chats = store.findChatsByName(name); + ``` +- Contacts + - Query a contact by its jid + ```java + var chat = store.findContactByJid(jid); + ``` + - Query a contact by its name + ```java + var contact = store.findContactByName(name); + ``` + - Query all contacts that match a name + ```java + var contacts = store.findContactsByName(name); + ``` +- Media status + - Query status by sender + ```java + var chat = store.findStatusBySender(contact); + ``` + +### How to query other data + +To access information about the companion device: +```java +var companion = store.jid(); +``` +This object is a jid like any other, but it has the device field filled to distinguish it from the main one. +Instead, if you only need the phone number: +```java +var phoneNumber = store.jid().toPhoneNumber(); +``` +All the settings and metadata about the companion is available inside the Store class +```java +var store = api.store(); +``` +Explore of the available methods! + +### How to query cryptographic data + +Access keys store associated with a connection by calling the keys method: +```java +var keys = api.keys(); +``` +There are several methods to access and query cryptographic data, but as it's only necessary for advanced users, +please check the javadocs if this is what you need. + +### How to send messages + +To send a message, start by finding the chat where the message should be sent. Here is an example: + +```java +var chat = api.store() + .findChatByName("My Awesome Friend") + .orElseThrow(() -> new NoSuchElementException("Hey, you don't exist")); +``` + +All types of messages supported by Whatsapp are supported by this library: +> **_IMPORTANT:_** Buttons are not documented here because they are unstable. +> If you are interested you can try to use them, but they are not guaranteed to work. +> There are some examples in the tests directory. + +- Text + + ```java + api.sendMessage(chat, "This is a text message!"); + ``` + +- Complex text + + ```java + var message = new TextMessageBuilder() // Create a new text message + .text("Check this video out: https://www.youtube.com/watch?v=dQw4w9WgXcQ") // Set the text of the message + .canonicalUrl("https://www.youtube.com/watch?v=dQw4w9WgXcQ") // Set the url of the message + .matchedText("https://www.youtube.com/watch?v=dQw4w9WgXcQ") // Set the matched text for the url in the message + .title("A nice suprise") // Set the title of the url + .description("Check me out") // Set the description of the url + .build(); // Create the message + api.sendMessage(chat, message); + ``` + +- Location + + ```java + var location = new LocationMessageBuilder() // Create a new location message + .caption("Look at this!") // Set the caption of the message, that is the text below the file + .latitude(38.9193) // Set the longitude of the location to share + .longitude(1183.1389) // Set the latitude of the location to share + .build(); // Create the message + api.sendMessage(chat, location); + ``` + +- Live location + + ```java + var location = new LiveLocationMessageBuilder() // Create a new live location message + .caption("Look at this!") // Set the caption of the message, that is the text below the file. Not available if this message is live + .latitude(38.9193) // Set the longitude of the location to share + .longitude(1183.1389) // Set the latitude of the location to share + .accuracy(10) // Set the accuracy of the location in meters + .speed(12) // Set the speed of the device sharing the location in meter per endTimeStamp + .build(); // Create the message + api.sendMessage(chat, location); + ``` + > **_IMPORTANT:_** Live location updates are not supported by Whatsapp multi-device. No ETA has been given for a fix. + +- Group invite + ```java + var group = api.store() + .findChatByName("Programmers") + .filter(Chat::isGroup) + .orElseThrow(() -> new NoSuchElementException("Hey, you don't exist")); + var inviteCode = api.queryGroupInviteCode(group).join(); + var groupInvite = new GroupInviteMessageBuilder() // Create a new group invite message + .caption("Come join my group of fellow programmers") // Set the caption of this message + .name(group.name()) // Set the name of the group + .groupJid(group.jid())) // Set the jid of the group + .inviteExpiration(ZonedDateTime.now().plusDays(3).toEpochSecond()) // Set the expiration of this invite + .inviteCode(inviteCode) // Set the code of the group + .build(); // Create the message + api.sendMessage(chat, groupInvite); + ``` + +- Contact + ```java + var vcard = new ContactCardBuilder() // Create a new vcard + .name("A nice friend") // Set the name of the contact + .phoneNumber(contact) // Set the phone number of the contact + .build(); // Create the vcard + var contactMessage = new ContactMessageBuilder() // Create a new contact message + .name("A nice friend") // Set the display name of the contact + .vcard(vcard) // Set the vcard(https://en.wikipedia.org/wiki/VCard) of the contact + .build(); // Create the message + api.sendMessage(chat, contactMessage); + ``` + +- Contact array + + ```java + var contactsMessage = new ContactsArrayMessageBuilder() // Create a new contacts array message + .name("A nice friend") // Set the display name of the first contact that this message contains + .contacts(List.of(jack,lucy,jeff)) // Set a list of contact messages that this message wraps + .build(); // Create the message + api.sendMessage(chat, contactsMessage); + ``` + +- Media + + > **_IMPORTANT:_** + > + > The thumbnail for videos and gifs is generated automatically only if ffmpeg is installed on the host machine. + > + > The length of videos, gifs and audios in seconds is computed automatically only if ffprobe is installed on the host machine. + + To send a media, start by reading the content inside a byte array. + You might want to read it from a file: + + ```java + var media = Files.readAllBytes(Path.of("somewhere")); + ``` + + Or from a URL: + + ```java + var media = new URL(url).openStream().readAllBytes(); + ``` + + All medias supported by Whatsapp are supported by this library: + + - Image + + ```java + var image = new ImageMessageSimpleBuilder() // Create a new image message builder + .media(media) // Set the image of this message + .caption("A nice image") // Set the caption of this message + .build(); // Create the message + api.sendMessage(chat, image); + ``` + + - Audio or voice + + ```java + var audio = new AudioMessageSimpleBuilder() // Create a new audio message builder + .media(urlMedia) // Set the audio of this message + .voiceMessage(false) // Set whether this message is a voice message + .build(); // Create the message + api.sendMessage(chat, audio); + ``` + + - Video + + ```java + var video = new VideoMessageSimpleBuilder() // Create a new video message builder + .media(urlMedia) // Set the video of this message + .caption("A nice video") // Set the caption of this message + .width(100) // Set the width of the video + .height(100) // Set the height of the video + .build(); // Create the message + api.sendMessage(chat, video); + ``` + + - GIF(Video) + + ```java + var gif = new GifMessageSimpleBuilder() // Create a new gif message builder + .media(urlMedia) // Set the gif of this message + .caption("A nice gif") // Set the caption of this message + .gifAttribution(VideoMessageAttribution.TENOR) // Set the source of the gif + .build(); // Create the message + api.sendMessage(chat, gif); + ``` + > **_IMPORTANT:_** Whatsapp doesn't support conventional gifs. Instead, videos can be played as gifs if particular attributes are set. Sending a conventional gif will result in an exception if detected or in undefined behaviour. + + - Document + + ```java + var document = new DocumentMessageSimpleBuilder() // Create a new document message builder + .media(urlMedia) // Set the document of this message + .title("A nice pdf") // Set the title of the document + .fileName("pdf-test.pdf") // Set the name of the document + .pageCount(1) // Set the number of pages of the document + .build(); // Create the message + api.sendMessage(chat, document); + ``` +- Reaction + + - Send a reaction + + ```java + var someMessage = ...; // The message to react to + api.sendReaction(someMessage, Emoji.RED_HEART); // Use the Emoji class for a list of all Emojis + ``` + + - Remove a reaction + + ```java + var someMessage = ...; // The message to react to + api.removeReaction(someMessage); // Use the Emoji class for a list of all Emojis + ``` + +### How to wait for replies + +If you want to wait for a single reply, use: +``` java +var response = api.awaitReply(info).join(); +``` + +You can also register a listener, but in many cases the async/await paradigm is easier to use then callback based listeners. + +### How to delete messages + +``` java +var result = api.delete(someMessage, everyone); // Deletes a message for yourself or everyone +``` + +### How to change your status + +To change the status of the client: + +``` java +api.changePresence(true); // online +api.changePresence(false); // offline +``` + +If you want to change the status of your companion, start by choosing the right presence: +These are the allowed values: + +- AVAILABLE +- UNAVAILABLE +- COMPOSING +- RECORDING + +Then, execute this method: + +``` java +api.changePresence(chat, presence); +``` + +> **_IMPORTANT:_** The changePresence method returns a CompletableFuture: remember to handle this async construct if +> needed + +### How to query the last known presence for a contact + +To query the last known status of a Contact, use the following snippet: + +``` java +var lastKnownPresenceOptional = contact.lastKnownPresence(); +``` + +If the returned value is an empty Optional, the last status of the contact is unknown. + +Whatsapp starts sending updates regarding the presence of a contact only when: + +- A message was recently exchanged between you and said contact +- A new message arrives from said contact +- You send a message to said contact + +To force Whatsapp to send these updates use: + +``` java +api.subscribeToPresence(contact); +``` + +Then, after the subscribeToUserPresence's future is completed, query again the presence of that contact. + +### Query data about a group, or a contact + +##### About + +``` java +var status = api.queryAbout(contact) // A completable future + .join() // Wait for the future to complete + .flatMap(ContactAboutResponse::about) // Map the response to its status + .orElse(null); // If no status is available yield null +``` + +##### Profile picture or chat picture + +``` java +var picture = api.queryPicture(contact) // A completable future + .join() // Wait for the future to complete + .orElse(null); // If no picture is available yield null +``` + +##### Group's Metadata + +``` java +var metadata = api.queryGroupMetadata(group); // A completable future + .join(); // Wait for the future to complete +``` + +### Search messages + +``` java +var messages = chat.messages(); // All the messages in a chat +var firstMessage = chat.firstMessage(); // First message in a chat chronologically +var lastMessage = chat.lastMessage(); // Last message in a chat chronologically +var starredMessages = chat.starredMessages(); // All the starred messages in a chat +``` + +### Change the state of a chat + +##### Mute a chat + +``` java +var future = api.muteChat(chat); +``` + +##### Unmute a chat + +``` java +var future = api.unmuteChat(chat); +``` + +##### Archive a chat + +``` java +var future = api.archiveChat(chat); +``` + +##### Unarchive a chat + +``` java +var future = api.unarchiveChat(chat); +``` + +##### Change ephemeral message status in a chat + +``` java +var future = api.changeEphemeralTimer(chat, ChatEphemeralTimer.ONE_WEEK); +``` + +##### Mark a chat as read + +``` java +var future = api.markChatRead(chat); +``` + +##### Mark a chat as unread + +``` java +var future = api.markChatUnread(chat); +``` + +##### Pin a chat + +``` java +var future = api.pinChat(chat); +``` + +##### Unpin a chat + +``` java +var future = api.unpinChat(chat); +``` + +##### Clear a chat + +``` java +var future = api.clearChat(chat, false); +``` + +##### Delete a chat + +``` java +var future = api.deleteChat(chat); +``` + +### Change the state of a participant of a group + +##### Add a contact to a group + +``` java +var future = api.addGroupParticipant(group, contact); +``` + +##### Remove a contact from a group + +``` java +var future = api.removeGroupParticipant(group, contact); +``` + +##### Promote a contact to admin in a group + +``` java +var future = api.promoteGroupParticipant(group, contact); +``` + +##### Demote a contact to user in a group + +``` java +var future = api.demoteGroupParticipant(group, contact); +``` + +### Change the metadata or settings of a group + +##### Change group's name/subject + +``` java +var future = api.changeGroupSubject(group, newName); +``` + +##### Change or remove group's description + +``` java +var future = api.changeGroupDescription(group, newDescription); +``` + +##### Change a setting in a group + +``` java +var future = api.changeGroupSetting(group, GroupSetting.EDIT_GROUP_INFO, GroupPolicy.ANYONE); +``` + +##### Change or remove the picture of a group + +``` java +var future = api.changeGroupPicture(group, img); +``` + +### Other group related methods + +##### Create a group + +``` java +var future = api.createGroup("A nice name :)", friend, friend2); +``` + +##### Leave a group + +``` java +var future = api.leaveGroup(group); +``` + +##### Query a group's invite code + +``` java +var future = api.queryGroupInviteCode(group); +``` + +##### Revoke a group's invite code + +``` java +var future = api.revokeGroupInvite(group); +``` + +##### Accept a group invite + +``` java +var future = api.acceptGroupInvite(inviteCode); +``` + +### Companions (Mobile api only) + +##### Link a companion + +``` java +var future = api.linkCompanion(qrCode); +``` + +##### Unlink a companion + +``` java +var future = api.unlinkCompanion(companionJid); +``` + +##### Unlink all companions + +``` java +var future = api.unlinkCompanions(); +``` + +### 2FA (Mobile api only) + +##### Enable 2FA + +``` java +var future = api.enable2fa("000000", "mail@domain.com"); +``` + +##### Disable 2FA + +``` java +var future = api.disable2fa(); +``` + +### Calls (Mobile api only) + +##### Start a call + +``` java +var future = api.startCall(contact); +``` + +> **_IMPORTANT:_** Currently there is no audio/video support + +##### Stop or reject a call + +``` java +var future = api.stopCall(contact); +``` + +### Communities + +> **_IMPORTANT:_** Fully supported, but not documented here. Check the Javadocs. + +### Newsletters + +> **_IMPORTANT:_** Fully supported, but not documented here. Check the Javadocs. + +Some methods may not be listed here, all contributions are welcomed to this documentation! +Some methods may not be supported on the mobile api, please report them, so I can fix them. +Ideally I'd like all of them to work. diff --git a/cobalt.iml b/cobalt.iml new file mode 100644 index 000000000..339339347 --- /dev/null +++ b/cobalt.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/mvnw b/mvnw new file mode 100755 index 000000000..8d937f4c1 --- /dev/null +++ b/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/mvnw.cmd b/mvnw.cmd new file mode 100644 index 000000000..f80fbad3e --- /dev/null +++ b/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/pom.xml b/pom.xml new file mode 100644 index 000000000..f7a12a29d --- /dev/null +++ b/pom.xml @@ -0,0 +1,371 @@ + + + 4.0.0 + com.github.auties00 + cobalt + 0.0.4 + ${project.groupId}:${project.artifactId} + Standalone fully-featured Whatsapp Web API for Java and Kotlin + https://github.com/Auties00/Cobalt + + + + Alessandro Autiero + alautiero@gmail.com + + + + + + MIT License + https://www.opensource.org/licenses/mit-license.php + repo + + + + + https://github.com/Auties00/Cobalt/tree/master + scm:git:https://github.com/Auties00/Cobalt.git + scm:ssh:https://github.com/Auties00/Cobalt.git + + + + + ossrh + https://s01.oss.sonatype.org/content/repositories/snapshots + + + ossrh + https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/ + + + + + + AsposeJavaAPI + Aspose Java API + https://releases.aspose.com/java/repo/ + + + jitpack.io + Jitpack + https://jitpack.io + + + + + + sign + + + performRelease + true + + + + + + + org.apache.maven.plugins + maven-source-plugin + ${maven.source.plugin.version} + + + attach-sources + + jar + + + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + ${maven.javadoc.plugin.version} + + + attach-javadocs + + jar + + + + + ${java.version} + true + private + true + true + + + + + + org.apache.maven.plugins + maven-gpg-plugin + ${maven.gpg.plugin.version} + + + sign-artifacts + verify + + sign + + + ${gpg.keyname} + ${gpg.passphrase} + + --pinentry-mode + loopback + + + + + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + ${maven.nexus.plugin.version} + true + + ossrh + https://s01.oss.sonatype.org/ + true + + + + + + + uber-jar + + + + maven-assembly-plugin + + + jar-with-dependencies + + + + + make-assembly + package + + single + + + + + + + + + + jar + + + UTF-8 + 21 + 3.0.0-M9 + 3.0.1 + 3.11.0 + 3.2.1 + 3.5.0 + 1.6.13 + 3.5.1 + 3.0.4 + 5.10.0-M1 + 2.15.2 + 1.2 + 5.1.4 + 2.3 + 0.12.1 + 2.2 + 8.13.13 + 2.15.0 + master-SNAPSHOT + 1.27 + 22.11 + 2023.09.10 + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + ${maven.compiler.plugin.version} + + + process-test-annotations + generate-test-resources + + testCompile + + + + + ${groupId} + ${artifactId} + ${version} + + + + it.auties.whatsapp.listener.processor.RegisterListenerProcessor + + + + + + ${java.version} + ${java.version} + ${java.version} + + + com.github.auties00 + protobuf-serialization-plugin + ${protoc.version} + + + + -parameters + + true + + + + + + org.apache.maven.plugins + maven-surefire-plugin + ${maven.surefire.plugin.version} + + + org.junit.jupiter + junit-jupiter-engine + ${junit.version} + + + + + + + + + + com.google.zxing + javase + ${zxing.version} + + + com.github.auties00 + qr-terminal + ${qr.terminal.version} + + + + + com.github.auties00 + curve25519 + ${curve25519.version} + + + + + com.github.auties00 + protobuf-base + ${protoc.version} + + + + + com.fasterxml.jackson.core + jackson-databind + ${jackson.version} + + + com.fasterxml.jackson.module + jackson-module-parameter-names + ${jackson.version} + + + com.fasterxml.jackson.datatype + jackson-datatype-jdk8 + ${jackson.version} + + + com.fasterxml.jackson.datatype + jackson-datatype-jsr310 + ${jackson.version} + + + + + com.googlecode.libphonenumber + libphonenumber + ${libphonenumber.version} + + + + + com.github.Auties00 + apk-parser + ${apk.parser.version} + + + + + com.googlecode.plist + dd-plist + ${plist.version} + + + + + com.github.auties00 + link-preview + ${linkpreview.version} + + + com.aspose + aspose-words + ${aspose.words.version} + jdk17 + + + com.github.kokorin.jaffree + jaffree + ${ffmpeg.version} + + + org.slf4j + slf4j-api + 1.7.32 + + + com.googlecode.ez-vcard + ez-vcard + ${vcard.version} + + + + + org.junit.jupiter + junit-jupiter + ${junit.version} + test + + + org.junit.jupiter + junit-jupiter-engine + ${junit.version} + test + + + diff --git a/proto/extractor/.gitignore b/proto/extractor/.gitignore new file mode 100644 index 000000000..28f1ba756 --- /dev/null +++ b/proto/extractor/.gitignore @@ -0,0 +1,2 @@ +node_modules +.DS_Store \ No newline at end of file diff --git a/proto/extractor/README.md b/proto/extractor/README.md new file mode 100644 index 000000000..fc9e60329 --- /dev/null +++ b/proto/extractor/README.md @@ -0,0 +1,8 @@ +# Proto Extract + +Derived initially from `whatseow`'s proto extract, this version generates a predictable diff friendly protobuf. It also does not rely on a hardcoded set of modules to look for but finds all proto modules on its own and extracts the proto from there. + +## Usage +1. Install dependencies with `yarn` (or `npm install`) +2. `yarn start` +3. The script will update `../WAProto/WAProto.proto` (except if something is broken) diff --git a/proto/extractor/index.js b/proto/extractor/index.js new file mode 100644 index 000000000..3637eb27c --- /dev/null +++ b/proto/extractor/index.js @@ -0,0 +1,382 @@ +const request = require('request-promise-native') +const acorn = require('acorn') +const walk = require('acorn-walk') +const fs = require('fs/promises') + +const addPrefix = (lines, prefix) => lines.map(line => prefix + line) + +const extractAllExpressions = (node) => { + const expressions = [node] + const exp = node.expression + if(exp) { + expressions.push(exp) + } + + if(node.expression?.expressions?.length) { + for(const exp of node.expression?.expressions) { + expressions.push(...extractAllExpressions(exp)) + } + } + + return expressions +} + +async function findAppModules() { + const ua = { + headers: { + 'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:100.0) Gecko/20100101 Firefox/100.0', + 'Sec-Fetch-Dest': 'script', + 'Sec-Fetch-Mode': 'no-cors', + 'Sec-Fetch-Site': 'same-origin', + 'Referer': 'https://web.whatsapp.com/', + 'Accept': '*/*', + 'Accept-Language': 'Accept-Language: en-US,en;q=0.5', + } + } + const baseURL = 'https://web.whatsapp.com' + const serviceworker = await request.get(`${baseURL}/serviceworker.js`, ua) + + const versions = [...serviceworker.matchAll(/assets-manifest-([\d\.]+).json/g)].map(r => r[1]) + const version = versions[0] + + let bootstrapQRURL = '' + if(version) { + const asset = await request.get(`${baseURL}/assets-manifest-${version}.json`, ua) + const hashFiles = JSON.parse(asset) + const files = Object.keys(hashFiles) + const app = files.find(f => /^app\./.test(f)) + bootstrapQRURL = `${baseURL}/${app}` + } else { + const index = await request.get(baseURL, ua) + const bootstrapQRID = index.match(/src="\/app.([0-9a-z]{10,}).js"/)[1] + bootstrapQRURL = baseURL + '/app.' + bootstrapQRID + '.js' + } + + console.error('Found source JS URL:', bootstrapQRURL) + + const qrData = await request.get(bootstrapQRURL, ua) + const waVersion = qrData.match(/(?:appVersion:|VERSION_STR=)"(\d\.\d+\.\d+)"/)[1] + console.log('Current version:', waVersion) + // This one list of types is so long that it's split into two JavaScript declarations. + // The module finder below can't handle it, so just patch it manually here. + const patchedQrData = qrData.replace('t.ActionLinkSpec=void 0,t.TemplateButtonSpec', 't.ActionLinkSpec=t.TemplateButtonSpec') + //const patchedQrData = qrData.replace("Spec=void 0,t.", "Spec=t.") + const qrModules = acorn.parse(patchedQrData).body[0].expression.arguments[0].elements[1].properties + + const result = qrModules.filter(m => { + const hasProto = !!m.value.body.body.find(b => { + const expressions = extractAllExpressions(b) + return expressions?.find(e => e?.left?.property?.name === 'internalSpec') + }) + if(hasProto) { + return true + } + }) + + return result +} + +(async() => { + const unspecName = name => name.endsWith('Spec') ? name.slice(0, -4) : name + const unnestName = name => name.split('$').slice(-1)[0] + const getNesting = name => name.split('$').slice(0, -1).join('$') + const makeRenameFunc = () => ( + name => { + name = unspecName(name) + return name// .replaceAll('$', '__') + // return renames[name] ?? unnestName(name) + } + ) + // The constructor IDs that can be used for enum types + // const enumConstructorIDs = [76672, 54302] + + const modules = await findAppModules() + + // Sort modules so that whatsapp module id changes don't change the order in the output protobuf schema + // const modules = [] + // for (const mod of wantedModules) { + // modules.push(unsortedModules.find(node => node.key.value === mod)) + // } + + // find aliases of cross references between the wanted modules + const modulesInfo = {} + const moduleIndentationMap = {} + modules.forEach(({ key, value }) => { + const requiringParam = value.params[2].name + modulesInfo[key.value] = { crossRefs: [] } + walk.simple(value, { + VariableDeclarator(node) { + if(node.init && node.init.type === 'CallExpression' && node.init.callee.name === requiringParam && node.init.arguments.length === 1) { + modulesInfo[key.value].crossRefs.push({ alias: node.id.name, module: node.init.arguments[0].value }) + } + } + }) + }) + + // find all identifiers and, for enums, their array of values + for(const mod of modules) { + const modInfo = modulesInfo[mod.key.value] + const rename = makeRenameFunc(mod.key.value) + + // all identifiers will be initialized to "void 0" (i.e. "undefined") at the start, so capture them here + walk.ancestor(mod, { + UnaryExpression(node, anc) { + if(!modInfo.identifiers && node.operator === 'void') { + const assignments = [] + let i = 1 + anc.reverse() + while(anc[i].type === 'AssignmentExpression') { + assignments.push(anc[i++].left) + } + + const makeBlankIdent = a => { + const key = rename(a.property.name) + const indentation = getNesting(key) + const value = { name: key } + + moduleIndentationMap[key] = moduleIndentationMap[key] || { } + moduleIndentationMap[key].indentation = indentation + + if(indentation.length) { + moduleIndentationMap[indentation] = moduleIndentationMap[indentation] || { } + moduleIndentationMap[indentation].members = moduleIndentationMap[indentation].members || new Set() + moduleIndentationMap[indentation].members.add(key) + } + + return [key, value] + } + + modInfo.identifiers = Object.fromEntries(assignments.map(makeBlankIdent).reverse()) + + } + } + }) + const enumAliases = {} + // enums are defined directly, and both enums and messages get a one-letter alias + walk.simple(mod, { + VariableDeclarator(node) { + if( + node.init?.type === 'CallExpression' + // && enumConstructorIDs.includes(node.init.callee?.arguments?.[0]?.value) + && !!node.init.arguments.length + && node.init.arguments[0].type === 'ObjectExpression' + && node.init.arguments[0].properties.length + ) { + const values = node.init.arguments[0].properties.map(p => ({ + name: p.key.name, + id: p.value.value + })) + enumAliases[node.id.name] = values + } + }, + AssignmentExpression(node) { + if(node.left.type === 'MemberExpression' && modInfo.identifiers[rename(node.left.property.name)]) { + const ident = modInfo.identifiers[rename(node.left.property.name)] + ident.alias = node.right.name + // enumAliases[ident.alias] = enumAliases[ident.alias] || [] + ident.enumValues = enumAliases[ident.alias] + } + }, + }) + } + + // find the contents for all protobuf messages + for(const mod of modules) { + const modInfo = modulesInfo[mod.key.value] + const rename = makeRenameFunc(mod.key.value) + + // message specifications are stored in a "internalSpec" attribute of the respective identifier alias + walk.simple(mod, { + AssignmentExpression(node) { + if(node.left.type === 'MemberExpression' && node.left.property.name === 'internalSpec' && node.right.type === 'ObjectExpression') { + const targetIdent = Object.values(modInfo.identifiers).find(v => v.alias === node.left.object.name) + if(!targetIdent) { + console.warn(`found message specification for unknown identifier alias: ${node.left.object.name}`) + return + } + + // partition spec properties by normal members and constraints (like "__oneofs__") which will be processed afterwards + const constraints = [] + let members = [] + for(const p of node.right.properties) { + p.key.name = p.key.type === 'Identifier' ? p.key.name : p.key.value + const arr = p.key.name.substr(0, 2) === '__' ? constraints : members + arr.push(p) + } + + members = members.map(({ key: { name }, value: { elements } }) => { + let type + const flags = [] + const unwrapBinaryOr = n => (n.type === 'BinaryExpression' && n.operator === '|') ? [].concat(unwrapBinaryOr(n.left), unwrapBinaryOr(n.right)) : [n] + + // find type and flags + unwrapBinaryOr(elements[1]).forEach(m => { + if(m.type === 'MemberExpression' && m.object.type === 'MemberExpression') { + if(m.object.property.name === 'TYPES') { + type = m.property.name.toLowerCase() + } else if(m.object.property.name === 'FLAGS') { + flags.push(m.property.name.toLowerCase()) + } + } + }) + + // determine cross reference name from alias if this member has type "message" or "enum" + if(type === 'message' || type === 'enum') { + const currLoc = ` from member '${name}' of message '${targetIdent.name}'` + if(elements[2].type === 'Identifier') { + type = Object.values(modInfo.identifiers).find(v => v.alias === elements[2].name)?.name + if(!type) { + console.warn(`unable to find reference of alias '${elements[2].name}'` + currLoc) + } + } else if(elements[2].type === 'MemberExpression') { + const crossRef = modInfo.crossRefs.find(r => r.alias === elements[2].object.name) + if(crossRef && modulesInfo[crossRef.module].identifiers[rename(elements[2].property.name)]) { + type = rename(elements[2].property.name) + } else { + console.warn(`unable to find reference of alias to other module '${elements[2].object.name}' or to message ${elements[2].property.name} of this module` + currLoc) + } + } + } + + return { name, id: elements[0].value, type, flags } + }) + + // resolve constraints for members + constraints.forEach(c => { + if(c.key.name === '__oneofs__' && c.value.type === 'ObjectExpression') { + const newOneOfs = c.value.properties.map(p => ({ + name: p.key.name, + type: '__oneof__', + members: p.value.elements.map(e => { + const idx = members.findIndex(m => m.name === e.value) + const member = members[idx] + members.splice(idx, 1) + return member + }) + })) + members.push(...newOneOfs) + } + }) + + targetIdent.members = members + } + } + }) + } + + const decodedProtoMap = { } + const spaceIndent = ' '.repeat(4) + for(const mod of modules) { + const modInfo = modulesInfo[mod.key.value] + const identifiers = Object.values(modInfo.identifiers) + + // enum stringifying function + const stringifyEnum = (ident, overrideName = null) => [].concat( + [`enum ${overrideName || ident.displayName || ident.name} {`], + addPrefix(ident.enumValues.map(v => `${v.name} = ${v.id};`), spaceIndent), + ['}'] + ) + + // message specification member stringifying function + const stringifyMessageSpecMember = (info, completeFlags, parentName = undefined) => { + if(info.type === '__oneof__') { + return [].concat( + [`oneof ${info.name} {`], + addPrefix([].concat(...info.members.map(m => stringifyMessageSpecMember(m, false))), spaceIndent), + ['}'] + ) + } else { + if(info.flags.includes('packed')) { + info.flags.splice(info.flags.indexOf('packed')) + info.packed = ' [packed=true]' + } + + if(completeFlags && info.flags.length === 0) { + info.flags.push('optional') + } + + const ret = [] + const indentation = moduleIndentationMap[info.type]?.indentation + let typeName = unnestName(info.type) + if(indentation !== parentName && indentation) { + typeName = `${indentation.replaceAll('$', '.')}.${typeName}` + } + + // if(info.enumValues) { + // // typeName = unnestName(info.type) + // ret = stringifyEnum(info, typeName) + // } + + ret.push(`${info.flags.join(' ') + (info.flags.length === 0 ? '' : ' ')}${typeName} ${info.name} = ${info.id}${info.packed || ''};`) + return ret + } + } + + // message specification stringifying function + const stringifyMessageSpec = (ident) => { + const members = moduleIndentationMap[ident.name]?.members + const result = [] + result.push( + `message ${ident.displayName || ident.name} {`, + ...addPrefix([].concat(...ident.members.map(m => stringifyMessageSpecMember(m, true, ident.name))), spaceIndent), + ) + + if(members?.size) { + const sortedMembers = Array.from(members).sort() + for(const memberName of sortedMembers) { + let entity = modInfo.identifiers[memberName] + if(entity) { + const displayName = entity.name.slice(ident.name.length + 1) + entity = { ...entity, displayName } + result.push(...addPrefix(getEntity(entity), spaceIndent)) + } else { + console.log('missing nested entity ', memberName) + } + } + } + + result.push('}') + result.push('') + + return result + } + + const getEntity = (v) => { + let result + if(v.members) { + result = stringifyMessageSpec(v) + } else if(v.enumValues?.length) { + result = stringifyEnum(v) + } else { + result = ['// Unknown entity ' + v.name] + } + + return result + } + + const stringifyEntity = v => { + return { + content: getEntity(v).join('\n'), + name: v.name + } + } + + for(const value of identifiers) { + const { name, content } = stringifyEntity(value) + if(!moduleIndentationMap[name]?.indentation?.length) { + decodedProtoMap[name] = content + } + // decodedProtoMap[name] = content + } + } + + // console.log(moduleIndentationMap) + const decodedProto = Object.keys(decodedProtoMap).sort() + const sortedStr = decodedProto.map(d => decodedProtoMap[d]).join('\n') + + const decodedProtoStr = `syntax = "proto2";\n\npackage it.auties.whatsapp.model.unsupported;\n\n\n${sortedStr}` + const destinationPath = '../whatsapp.proto' + await fs.writeFile(destinationPath, decodedProtoStr) + + console.log(`Extracted protobuf schema to "${destinationPath}"`) +})() diff --git a/proto/extractor/package-lock.json b/proto/extractor/package-lock.json new file mode 100644 index 000000000..2df632b85 --- /dev/null +++ b/proto/extractor/package-lock.json @@ -0,0 +1,509 @@ +{ + "name": "whatsapp-web-protobuf-extractor", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "whatsapp-web-protobuf-extractor", + "version": "1.0.0", + "dependencies": { + "acorn": "^6.4.1", + "acorn-walk": "^6.1.1", + "request": "^2.88.0", + "request-promise-core": "^1.1.2", + "request-promise-native": "^1.0.7" + } + }, + "node_modules/acorn": { + "version": "6.4.2", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-6.4.2.tgz", + "integrity": "sha512-XtGIhXwF8YM8bJhGxG5kXgjkEuNGLTkoYqVE+KMR+aspr4KGYmKYg7yUe3KghyQ9yheNwLnjmzh/7+gfDBmHCQ==", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-walk": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-6.2.0.tgz", + "integrity": "sha512-7evsyfH1cLOCdAzZAd43Cic04yKydNx0cF+7tiA19p1XnLLPU4dpCQOqpjqwokFe//vS0QqfqqjCS2JkiIs0cA==", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/asn1": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz", + "integrity": "sha512-jxwzQpLQjSmWXgwaCZE9Nz+glAG01yF1QnWgbhGwHI5A6FRIEY6IVqtHhIepHqI7/kyEyQEagBC5mBEFlIYvdg==", + "dependencies": { + "safer-buffer": "~2.1.0" + } + }, + "node_modules/assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU= sha512-NfJ4UzBCcQGLDlQq7nHxH+tv3kyZ0hHQqF5BO6J7tNJeP5do1llPr8dZ8zHonfhAu0PHAdMkSo+8o0wxg9lZWw==", + "engines": { + "node": ">=0.8" + } + }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k= sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" + }, + "node_modules/aws-sign2": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", + "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg= sha512-08kcGqnYf/YmjoRhfxyu+CLxBjUtHLXLXX/vUfx9l2LYzG3c1m61nrpyFUZI6zeS+Li/wWMMidD9KgrqtGq3mA==", + "engines": { + "node": "*" + } + }, + "node_modules/aws4": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.11.0.tgz", + "integrity": "sha512-xh1Rl34h6Fi1DC2WWKfxUTVqRsNnr6LsKz2+hfwDxQJWmrx8+c7ylaqBMcHfl1U1r2dsifOvKX3LQuLNZ+XSvA==" + }, + "node_modules/bcrypt-pbkdf": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", + "integrity": "sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4= sha512-qeFIXtP4MSoi6NLqO12WfqARWWuCKi2Rn/9hJLEmtB5yTNr9DqFWkJRCf2qShWzPeAMRnOgCrq0sg/KLv5ES9w==", + "dependencies": { + "tweetnacl": "^0.14.3" + } + }, + "node_modules/caseless": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", + "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw= sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw==" + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac= sha512-3lqz5YjWTYnW6dlDa5TLaTCcShfar1e40rmcJVwCBJC6mWlFuj0eCHIElmG1g5kyuJ/GD+8Wn4FFCcz4gJPfaQ==" + }, + "node_modules/dashdash": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", + "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA= sha512-jRFi8UDGo6j+odZiEpjazZaWqEal3w/basFjQHQEwVtZJGDpxbH1MeYluwCS8Xq5wmLJooDlMgvVarmWfGM44g==", + "dependencies": { + "assert-plus": "^1.0.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk= sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/ecc-jsbn": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", + "integrity": "sha1-OoOpBOVDUyh4dMVkt1SThoSamMk= sha512-eh9O+hwRHNbG4BLTjEl3nw044CkGm5X6LoaCf7LPp7UU8Qrt47JYNi6nPX8xjW97TKGKm1ouctg0QSpZe9qrnw==", + "dependencies": { + "jsbn": "~0.1.0", + "safer-buffer": "^2.1.0" + } + }, + "node_modules/extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==" + }, + "node_modules/extsprintf": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", + "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU= sha512-11Ndz7Nv+mvAC1j0ktTa7fAb0vLyGGX+rMHNBYQviQDGU0Hw7lhctJANqbPhu9nV9/izT/IntTgZ7Im/9LJs9g==", + "engines": [ + "node >=0.6.0" + ] + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + }, + "node_modules/forever-agent": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", + "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE= sha512-j0KLYPhm6zeac4lz3oJ3o65qvgQCcPubiyotZrXqEaG4hNagNYO8qdlUrX5vwqv9ohqeT/Z3j6+yW067yWWdUw==", + "engines": { + "node": "*" + } + }, + "node_modules/form-data": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz", + "integrity": "sha512-1lLKB2Mu3aGP1Q/2eCOx0fNbRMe7XdwktwOruhfqqd0rIJWwN4Dh+E3hrPSlDCXnSR7UtZ1N38rVXm+6+MEhJQ==", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.6", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 0.12" + } + }, + "node_modules/getpass": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", + "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo= sha512-0fzj9JxOLfJ+XGLhR8ze3unN0KZCgZwiSSDz168VERjK8Wl8kVSdcu2kspd4s4wtAa1y/qrVRiAA0WclVsu0ng==", + "dependencies": { + "assert-plus": "^1.0.0" + } + }, + "node_modules/har-schema": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", + "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI= sha512-Oqluz6zhGX8cyRaTQlFMPw80bSJVG2x/cFb8ZPhUILGgHka9SsokCCOQgpveePerqidZOrT14ipqfJb7ILcW5Q==", + "engines": { + "node": ">=4" + } + }, + "node_modules/har-validator": { + "version": "5.1.5", + "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.1.5.tgz", + "integrity": "sha512-nmT2T0lljbxdQZfspsno9hgrG3Uir6Ks5afism62poxqBM6sDnMEuPmzTq8XN0OEwqKLLdh1jQI3qyE66Nzb3w==", + "deprecated": "this library is no longer supported", + "dependencies": { + "ajv": "^6.12.3", + "har-schema": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/http-signature": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", + "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE= sha512-CAbnr6Rz4CYQkLYUtSNXxQPUH2gK8f3iWexVlsnMeD+GjlsQ0Xsy1cOX+mN3dtxYomRy21CiOzU8Uhw6OwncEQ==", + "dependencies": { + "assert-plus": "^1.0.0", + "jsprim": "^1.2.2", + "sshpk": "^1.7.0" + }, + "engines": { + "node": ">=0.8", + "npm": ">=1.3.7" + } + }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo= sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==" + }, + "node_modules/isstream": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", + "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo= sha512-Yljz7ffyPbrLpLngrMtZ7NduUgVvi6wG9RJ9IUcyCd59YQ911PBJphODUcbOVbqYfxe1wuYf/LJ8PauMRwsM/g==" + }, + "node_modules/jsbn": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", + "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM= sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg==" + }, + "node_modules/json-schema": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", + "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM= sha512-a3xHnILGMtk+hDOqNwHzF6e2fNbiMrXZvxKQiEv2MlgQP+pjIOzqAmKYD2mDpXYE/44M7g+n9p2bKkYWDUcXCQ==" + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==" + }, + "node_modules/json-stringify-safe": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", + "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus= sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA==" + }, + "node_modules/jsprim": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", + "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI= sha512-4Dj8Rf+fQ+/Pn7C5qeEX02op1WfOss3PKTE9Nsop3Dx+6UPxlm1dr/og7o2cRa5hNN07CACr4NFzRLtj/rjWog==", + "engines": [ + "node >=0.6.0" + ], + "dependencies": { + "assert-plus": "1.0.0", + "extsprintf": "1.3.0", + "json-schema": "0.2.3", + "verror": "1.10.0" + } + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" + }, + "node_modules/mime-db": { + "version": "1.50.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.50.0.tgz", + "integrity": "sha512-9tMZCDlYHqeERXEHO9f/hKfNXhre5dK2eE/krIvUjZbS2KPcqGDfNShIWS1uW9XOTKQKqK6qbeOci18rbfW77A==", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.33", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.33.tgz", + "integrity": "sha512-plLElXp7pRDd0bNZHw+nMd52vRYjLwQjygaNg7ddJ2uJtTlmnTCjWuPKxVu6//AdaRuME84SvLW91sIkBqGT0g==", + "dependencies": { + "mime-db": "1.50.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/oauth-sign": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", + "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==", + "engines": { + "node": "*" + } + }, + "node_modules/performance-now": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", + "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns= sha512-7EAHlyLHI56VEIdK57uwHdHKIaAGbnXPiw0yWbarQZOKaKpvUIgW0jWRVLiatnM+XXlSwsanIBH/hzGMJulMow==" + }, + "node_modules/psl": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.8.0.tgz", + "integrity": "sha512-RIdOzyoavK+hA18OGGWDqUTsCLhtA7IcZ/6NCs4fFJaHBDab+pDDmDIByWFRQJq2Cd7r1OoQxBGKOaztq+hjIQ==" + }, + "node_modules/punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "engines": { + "node": ">=6" + } + }, + "node_modules/qs": { + "version": "6.5.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", + "integrity": "sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==", + "engines": { + "node": ">=0.6" + } + }, + "node_modules/request": { + "version": "2.88.2", + "resolved": "https://registry.npmjs.org/request/-/request-2.88.2.tgz", + "integrity": "sha512-MsvtOrfG9ZcrOwAW+Qi+F6HbD0CWXEh9ou77uOb7FM2WPhwT7smM833PzanhJLsgXjN89Ir6V2PczXNnMpwKhw==", + "deprecated": "request has been deprecated, see https://github.com/request/request/issues/3142", + "dependencies": { + "aws-sign2": "~0.7.0", + "aws4": "^1.8.0", + "caseless": "~0.12.0", + "combined-stream": "~1.0.6", + "extend": "~3.0.2", + "forever-agent": "~0.6.1", + "form-data": "~2.3.2", + "har-validator": "~5.1.3", + "http-signature": "~1.2.0", + "is-typedarray": "~1.0.0", + "isstream": "~0.1.2", + "json-stringify-safe": "~5.0.1", + "mime-types": "~2.1.19", + "oauth-sign": "~0.9.0", + "performance-now": "^2.1.0", + "qs": "~6.5.2", + "safe-buffer": "^5.1.2", + "tough-cookie": "~2.5.0", + "tunnel-agent": "^0.6.0", + "uuid": "^3.3.2" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/request-promise-core": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.4.tgz", + "integrity": "sha512-TTbAfBBRdWD7aNNOoVOBH4pN/KigV6LyapYNNlAPA8JwbovRti1E88m3sYAwsLi5ryhPKsE9APwnjFTgdUjTpw==", + "dependencies": { + "lodash": "^4.17.19" + }, + "engines": { + "node": ">=0.10.0" + }, + "peerDependencies": { + "request": "^2.34" + } + }, + "node_modules/request-promise-native": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.9.tgz", + "integrity": "sha512-wcW+sIUiWnKgNY0dqCpOZkUbF/I+YPi+f09JZIDa39Ec+q82CpSYniDp+ISgTTbKmnpJWASeJBPZmoxH84wt3g==", + "deprecated": "request-promise-native has been deprecated because it extends the now deprecated request package, see https://github.com/request/request/issues/3142", + "dependencies": { + "request-promise-core": "1.1.4", + "stealthy-require": "^1.1.1", + "tough-cookie": "^2.3.3" + }, + "engines": { + "node": ">=0.12.0" + }, + "peerDependencies": { + "request": "^2.34" + } + }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + }, + "node_modules/sshpk": { + "version": "1.16.1", + "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz", + "integrity": "sha512-HXXqVUq7+pcKeLqqZj6mHFUMvXtOJt1uoUx09pFW6011inTMxqI8BA8PM95myrIyyKwdnzjdFjLiE6KBPVtJIg==", + "dependencies": { + "asn1": "~0.2.3", + "assert-plus": "^1.0.0", + "bcrypt-pbkdf": "^1.0.0", + "dashdash": "^1.12.0", + "ecc-jsbn": "~0.1.1", + "getpass": "^0.1.1", + "jsbn": "~0.1.0", + "safer-buffer": "^2.0.2", + "tweetnacl": "~0.14.0" + }, + "bin": { + "sshpk-conv": "bin/sshpk-conv", + "sshpk-sign": "bin/sshpk-sign", + "sshpk-verify": "bin/sshpk-verify" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stealthy-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/stealthy-require/-/stealthy-require-1.1.1.tgz", + "integrity": "sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks= sha512-ZnWpYnYugiOVEY5GkcuJK1io5V8QmNYChG62gSit9pQVGErXtrKuPC55ITaVSukmMta5qpMU7vqLt2Lnni4f/g==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/tough-cookie": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.5.0.tgz", + "integrity": "sha512-nlLsUzgm1kfLXSXfRZMc1KLAugd4hqJHDTvc2hDIwS3mZAfMEuMbc03SujMF+GEcpaX/qboeycw6iO8JwVv2+g==", + "dependencies": { + "psl": "^1.1.28", + "punycode": "^2.1.1" + }, + "engines": { + "node": ">=0.8" + } + }, + "node_modules/tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0= sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w==", + "dependencies": { + "safe-buffer": "^5.0.1" + }, + "engines": { + "node": "*" + } + }, + "node_modules/tweetnacl": { + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", + "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q= sha512-KXXFFdAbFXY4geFIwoyNK+f5Z1b7swfXABfL7HXCmoIWMKU3dmS26672A4EeQtDzLKy7SXmfBu51JolvEKwtGA==" + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/uuid": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", + "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", + "deprecated": "Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.", + "bin": { + "uuid": "bin/uuid" + } + }, + "node_modules/verror": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", + "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA= sha512-ZZKSmDAEFOijERBLkmYfJ+vmk3w+7hOLYDNkRCuRuMJGEmqYNCNLyBBFwWKVMhfwaEF3WOd0Zlw86U/WC/+nYw==", + "engines": [ + "node >=0.6.0" + ], + "dependencies": { + "assert-plus": "^1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "^1.2.0" + } + } + } +} diff --git a/proto/extractor/package.json b/proto/extractor/package.json new file mode 100644 index 000000000..97ed950a4 --- /dev/null +++ b/proto/extractor/package.json @@ -0,0 +1,15 @@ +{ + "name": "whatsapp-web-protobuf-extractor", + "version": "1.0.0", + "main": "index.js", + "scripts": { + "start": "node index.js" + }, + "dependencies": { + "acorn": "^6.4.1", + "acorn-walk": "^6.1.1", + "request": "^2.88.0", + "request-promise-core": "^1.1.2", + "request-promise-native": "^1.0.7" + } +} diff --git a/proto/extractor/yarn.lock b/proto/extractor/yarn.lock new file mode 100644 index 000000000..61742b2ba --- /dev/null +++ b/proto/extractor/yarn.lock @@ -0,0 +1,352 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +acorn-walk@^6.1.1: + version "6.2.0" + resolved "https://registry.npmjs.org/acorn-walk/-/acorn-walk-6.2.0.tgz" + integrity sha512-7evsyfH1cLOCdAzZAd43Cic04yKydNx0cF+7tiA19p1XnLLPU4dpCQOqpjqwokFe//vS0QqfqqjCS2JkiIs0cA== + +acorn@^6.4.1: + version "6.4.2" + resolved "https://registry.npmjs.org/acorn/-/acorn-6.4.2.tgz" + integrity sha512-XtGIhXwF8YM8bJhGxG5kXgjkEuNGLTkoYqVE+KMR+aspr4KGYmKYg7yUe3KghyQ9yheNwLnjmzh/7+gfDBmHCQ== + +ajv@^6.12.3: + version "6.12.6" + resolved "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz" + integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +asn1@~0.2.3: + version "0.2.4" + resolved "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz" + integrity sha512-jxwzQpLQjSmWXgwaCZE9Nz+glAG01yF1QnWgbhGwHI5A6FRIEY6IVqtHhIepHqI7/kyEyQEagBC5mBEFlIYvdg== + dependencies: + safer-buffer "~2.1.0" + +assert-plus@^1.0.0, assert-plus@1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz" + integrity sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU= sha512-NfJ4UzBCcQGLDlQq7nHxH+tv3kyZ0hHQqF5BO6J7tNJeP5do1llPr8dZ8zHonfhAu0PHAdMkSo+8o0wxg9lZWw== + +asynckit@^0.4.0: + version "0.4.0" + resolved "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz" + integrity sha1-x57Zf380y48robyXkLzDZkdLS3k= sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q== + +aws-sign2@~0.7.0: + version "0.7.0" + resolved "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz" + integrity sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg= sha512-08kcGqnYf/YmjoRhfxyu+CLxBjUtHLXLXX/vUfx9l2LYzG3c1m61nrpyFUZI6zeS+Li/wWMMidD9KgrqtGq3mA== + +aws4@^1.8.0: + version "1.11.0" + resolved "https://registry.npmjs.org/aws4/-/aws4-1.11.0.tgz" + integrity sha512-xh1Rl34h6Fi1DC2WWKfxUTVqRsNnr6LsKz2+hfwDxQJWmrx8+c7ylaqBMcHfl1U1r2dsifOvKX3LQuLNZ+XSvA== + +bcrypt-pbkdf@^1.0.0: + version "1.0.2" + resolved "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz" + integrity sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4= sha512-qeFIXtP4MSoi6NLqO12WfqARWWuCKi2Rn/9hJLEmtB5yTNr9DqFWkJRCf2qShWzPeAMRnOgCrq0sg/KLv5ES9w== + dependencies: + tweetnacl "^0.14.3" + +caseless@~0.12.0: + version "0.12.0" + resolved "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz" + integrity sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw= sha512-4tYFyifaFfGacoiObjJegolkwSU4xQNGbVgUiNYVUxbQ2x2lUsFvY4hVgVzGiIe6WLOPqycWXA40l+PWsxthUw== + +combined-stream@^1.0.6, combined-stream@~1.0.6: + version "1.0.8" + resolved "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz" + integrity sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg== + dependencies: + delayed-stream "~1.0.0" + +core-util-is@1.0.2: + version "1.0.2" + resolved "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz" + integrity sha1-tf1UIgqivFq1eqtxQMlAdUUDwac= sha512-3lqz5YjWTYnW6dlDa5TLaTCcShfar1e40rmcJVwCBJC6mWlFuj0eCHIElmG1g5kyuJ/GD+8Wn4FFCcz4gJPfaQ== + +dashdash@^1.12.0: + version "1.14.1" + resolved "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz" + integrity sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA= sha512-jRFi8UDGo6j+odZiEpjazZaWqEal3w/basFjQHQEwVtZJGDpxbH1MeYluwCS8Xq5wmLJooDlMgvVarmWfGM44g== + dependencies: + assert-plus "^1.0.0" + +delayed-stream@~1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz" + integrity sha1-3zrhmayt+31ECqrgsp4icrJOxhk= sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ== + +ecc-jsbn@~0.1.1: + version "0.1.2" + resolved "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz" + integrity sha1-OoOpBOVDUyh4dMVkt1SThoSamMk= sha512-eh9O+hwRHNbG4BLTjEl3nw044CkGm5X6LoaCf7LPp7UU8Qrt47JYNi6nPX8xjW97TKGKm1ouctg0QSpZe9qrnw== + dependencies: + jsbn "~0.1.0" + safer-buffer "^2.1.0" + +extend@~3.0.2: + version "3.0.2" + resolved "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz" + integrity sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g== + +extsprintf@^1.2.0, extsprintf@1.3.0: + version "1.3.0" + resolved "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz" + integrity sha1-lpGEQOMEGnpBT4xS48V06zw+HgU= sha512-11Ndz7Nv+mvAC1j0ktTa7fAb0vLyGGX+rMHNBYQviQDGU0Hw7lhctJANqbPhu9nV9/izT/IntTgZ7Im/9LJs9g== + +fast-deep-equal@^3.1.1: + version "3.1.3" + resolved "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-json-stable-stringify@^2.0.0: + version "2.1.0" + resolved "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +forever-agent@~0.6.1: + version "0.6.1" + resolved "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz" + integrity sha1-+8cfDEGt6zf5bFd60e1C2P2sypE= sha512-j0KLYPhm6zeac4lz3oJ3o65qvgQCcPubiyotZrXqEaG4hNagNYO8qdlUrX5vwqv9ohqeT/Z3j6+yW067yWWdUw== + +form-data@~2.3.2: + version "2.3.3" + resolved "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz" + integrity sha512-1lLKB2Mu3aGP1Q/2eCOx0fNbRMe7XdwktwOruhfqqd0rIJWwN4Dh+E3hrPSlDCXnSR7UtZ1N38rVXm+6+MEhJQ== + dependencies: + asynckit "^0.4.0" + combined-stream "^1.0.6" + mime-types "^2.1.12" + +getpass@^0.1.1: + version "0.1.7" + resolved "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz" + integrity sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo= sha512-0fzj9JxOLfJ+XGLhR8ze3unN0KZCgZwiSSDz168VERjK8Wl8kVSdcu2kspd4s4wtAa1y/qrVRiAA0WclVsu0ng== + dependencies: + assert-plus "^1.0.0" + +har-schema@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz" + integrity sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI= sha512-Oqluz6zhGX8cyRaTQlFMPw80bSJVG2x/cFb8ZPhUILGgHka9SsokCCOQgpveePerqidZOrT14ipqfJb7ILcW5Q== + +har-validator@~5.1.3: + version "5.1.5" + resolved "https://registry.npmjs.org/har-validator/-/har-validator-5.1.5.tgz" + integrity sha512-nmT2T0lljbxdQZfspsno9hgrG3Uir6Ks5afism62poxqBM6sDnMEuPmzTq8XN0OEwqKLLdh1jQI3qyE66Nzb3w== + dependencies: + ajv "^6.12.3" + har-schema "^2.0.0" + +http-signature@~1.2.0: + version "1.2.0" + resolved "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz" + integrity sha1-muzZJRFHcvPZW2WmCruPfBj7rOE= sha512-CAbnr6Rz4CYQkLYUtSNXxQPUH2gK8f3iWexVlsnMeD+GjlsQ0Xsy1cOX+mN3dtxYomRy21CiOzU8Uhw6OwncEQ== + dependencies: + assert-plus "^1.0.0" + jsprim "^1.2.2" + sshpk "^1.7.0" + +is-typedarray@~1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz" + integrity sha1-5HnICFjfDBsR3dppQPlgEfzaSpo= sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA== + +isstream@~0.1.2: + version "0.1.2" + resolved "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz" + integrity sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo= sha512-Yljz7ffyPbrLpLngrMtZ7NduUgVvi6wG9RJ9IUcyCd59YQ911PBJphODUcbOVbqYfxe1wuYf/LJ8PauMRwsM/g== + +jsbn@~0.1.0: + version "0.1.1" + resolved "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz" + integrity sha1-peZUwuWi3rXyAdls77yoDA7y9RM= sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg== + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +json-schema@0.2.3: + version "0.2.3" + resolved "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz" + integrity sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM= sha512-a3xHnILGMtk+hDOqNwHzF6e2fNbiMrXZvxKQiEv2MlgQP+pjIOzqAmKYD2mDpXYE/44M7g+n9p2bKkYWDUcXCQ== + +json-stringify-safe@~5.0.1: + version "5.0.1" + resolved "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz" + integrity sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus= sha512-ZClg6AaYvamvYEE82d3Iyd3vSSIjQ+odgjaTzRuO3s7toCdFKczob2i0zCh7JE8kWn17yvAWhUVxvqGwUalsRA== + +jsprim@^1.2.2: + version "1.4.1" + resolved "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz" + integrity sha1-MT5mvB5cwG5Di8G3SZwuXFastqI= sha512-4Dj8Rf+fQ+/Pn7C5qeEX02op1WfOss3PKTE9Nsop3Dx+6UPxlm1dr/og7o2cRa5hNN07CACr4NFzRLtj/rjWog== + dependencies: + assert-plus "1.0.0" + extsprintf "1.3.0" + json-schema "0.2.3" + verror "1.10.0" + +lodash@^4.17.19: + version "4.17.21" + resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz" + integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== + +mime-db@1.50.0: + version "1.50.0" + resolved "https://registry.npmjs.org/mime-db/-/mime-db-1.50.0.tgz" + integrity sha512-9tMZCDlYHqeERXEHO9f/hKfNXhre5dK2eE/krIvUjZbS2KPcqGDfNShIWS1uW9XOTKQKqK6qbeOci18rbfW77A== + +mime-types@^2.1.12, mime-types@~2.1.19: + version "2.1.33" + resolved "https://registry.npmjs.org/mime-types/-/mime-types-2.1.33.tgz" + integrity sha512-plLElXp7pRDd0bNZHw+nMd52vRYjLwQjygaNg7ddJ2uJtTlmnTCjWuPKxVu6//AdaRuME84SvLW91sIkBqGT0g== + dependencies: + mime-db "1.50.0" + +oauth-sign@~0.9.0: + version "0.9.0" + resolved "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz" + integrity sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ== + +performance-now@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz" + integrity sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns= sha512-7EAHlyLHI56VEIdK57uwHdHKIaAGbnXPiw0yWbarQZOKaKpvUIgW0jWRVLiatnM+XXlSwsanIBH/hzGMJulMow== + +psl@^1.1.28: + version "1.8.0" + resolved "https://registry.npmjs.org/psl/-/psl-1.8.0.tgz" + integrity sha512-RIdOzyoavK+hA18OGGWDqUTsCLhtA7IcZ/6NCs4fFJaHBDab+pDDmDIByWFRQJq2Cd7r1OoQxBGKOaztq+hjIQ== + +punycode@^2.1.0, punycode@^2.1.1: + version "2.1.1" + resolved "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz" + integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A== + +qs@~6.5.2: + version "6.5.2" + resolved "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz" + integrity sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA== + +request-promise-core@^1.1.2, request-promise-core@1.1.4: + version "1.1.4" + resolved "https://registry.npmjs.org/request-promise-core/-/request-promise-core-1.1.4.tgz" + integrity sha512-TTbAfBBRdWD7aNNOoVOBH4pN/KigV6LyapYNNlAPA8JwbovRti1E88m3sYAwsLi5ryhPKsE9APwnjFTgdUjTpw== + dependencies: + lodash "^4.17.19" + +request-promise-native@^1.0.7: + version "1.0.9" + resolved "https://registry.npmjs.org/request-promise-native/-/request-promise-native-1.0.9.tgz" + integrity sha512-wcW+sIUiWnKgNY0dqCpOZkUbF/I+YPi+f09JZIDa39Ec+q82CpSYniDp+ISgTTbKmnpJWASeJBPZmoxH84wt3g== + dependencies: + request-promise-core "1.1.4" + stealthy-require "^1.1.1" + tough-cookie "^2.3.3" + +request@^2.34, request@^2.88.0: + version "2.88.2" + resolved "https://registry.npmjs.org/request/-/request-2.88.2.tgz" + integrity sha512-MsvtOrfG9ZcrOwAW+Qi+F6HbD0CWXEh9ou77uOb7FM2WPhwT7smM833PzanhJLsgXjN89Ir6V2PczXNnMpwKhw== + dependencies: + aws-sign2 "~0.7.0" + aws4 "^1.8.0" + caseless "~0.12.0" + combined-stream "~1.0.6" + extend "~3.0.2" + forever-agent "~0.6.1" + form-data "~2.3.2" + har-validator "~5.1.3" + http-signature "~1.2.0" + is-typedarray "~1.0.0" + isstream "~0.1.2" + json-stringify-safe "~5.0.1" + mime-types "~2.1.19" + oauth-sign "~0.9.0" + performance-now "^2.1.0" + qs "~6.5.2" + safe-buffer "^5.1.2" + tough-cookie "~2.5.0" + tunnel-agent "^0.6.0" + uuid "^3.3.2" + +safe-buffer@^5.0.1, safe-buffer@^5.1.2: + version "5.2.1" + resolved "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz" + integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== + +safer-buffer@^2.0.2, safer-buffer@^2.1.0, safer-buffer@~2.1.0: + version "2.1.2" + resolved "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz" + integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== + +sshpk@^1.7.0: + version "1.16.1" + resolved "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz" + integrity sha512-HXXqVUq7+pcKeLqqZj6mHFUMvXtOJt1uoUx09pFW6011inTMxqI8BA8PM95myrIyyKwdnzjdFjLiE6KBPVtJIg== + dependencies: + asn1 "~0.2.3" + assert-plus "^1.0.0" + bcrypt-pbkdf "^1.0.0" + dashdash "^1.12.0" + ecc-jsbn "~0.1.1" + getpass "^0.1.1" + jsbn "~0.1.0" + safer-buffer "^2.0.2" + tweetnacl "~0.14.0" + +stealthy-require@^1.1.1: + version "1.1.1" + resolved "https://registry.npmjs.org/stealthy-require/-/stealthy-require-1.1.1.tgz" + integrity sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks= sha512-ZnWpYnYugiOVEY5GkcuJK1io5V8QmNYChG62gSit9pQVGErXtrKuPC55ITaVSukmMta5qpMU7vqLt2Lnni4f/g== + +tough-cookie@^2.3.3, tough-cookie@~2.5.0: + version "2.5.0" + resolved "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.5.0.tgz" + integrity sha512-nlLsUzgm1kfLXSXfRZMc1KLAugd4hqJHDTvc2hDIwS3mZAfMEuMbc03SujMF+GEcpaX/qboeycw6iO8JwVv2+g== + dependencies: + psl "^1.1.28" + punycode "^2.1.1" + +tunnel-agent@^0.6.0: + version "0.6.0" + resolved "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz" + integrity sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0= sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w== + dependencies: + safe-buffer "^5.0.1" + +tweetnacl@^0.14.3, tweetnacl@~0.14.0: + version "0.14.5" + resolved "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz" + integrity sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q= sha512-KXXFFdAbFXY4geFIwoyNK+f5Z1b7swfXABfL7HXCmoIWMKU3dmS26672A4EeQtDzLKy7SXmfBu51JolvEKwtGA== + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +uuid@^3.3.2: + version "3.4.0" + resolved "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz" + integrity sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A== + +verror@1.10.0: + version "1.10.0" + resolved "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz" + integrity sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA= sha512-ZZKSmDAEFOijERBLkmYfJ+vmk3w+7hOLYDNkRCuRuMJGEmqYNCNLyBBFwWKVMhfwaEF3WOd0Zlw86U/WC/+nYw== + dependencies: + assert-plus "^1.0.0" + core-util-is "1.0.2" + extsprintf "^1.2.0" diff --git a/proto/gcm.proto b/proto/gcm.proto new file mode 100644 index 000000000..daad7babe --- /dev/null +++ b/proto/gcm.proto @@ -0,0 +1,542 @@ +// Copyright 2014 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. +// +// Logging information for Android "checkin" events (automatic, periodic +// requests made by Android devices to the server). + +syntax = "proto2"; + +option optimize_for = LITE_RUNTIME; +option go_package = ".;checkin_proto"; +package checkin_proto; + +// Build characteristics unique to the Chrome browser, and Chrome OS +message ChromeBuildProto { + enum Platform { + PLATFORM_WIN = 1; + PLATFORM_MAC = 2; + PLATFORM_LINUX = 3; + PLATFORM_CROS = 4; + PLATFORM_IOS = 5; + // Just a placeholder. Likely don't need it due to the presence of the + // Android GCM on phone/tablet devices. + PLATFORM_ANDROID = 6; + } + + enum Channel { + CHANNEL_STABLE = 1; + CHANNEL_BETA = 2; + CHANNEL_DEV = 3; + CHANNEL_CANARY = 4; + CHANNEL_UNKNOWN = 5; // for tip of tree or custom builds + } + + // The platform of the device. + optional Platform platform = 1; + + // The Chrome instance's version. + optional string chrome_version = 2; + + // The Channel (build type) of Chrome. + optional Channel channel = 3; +} + +// Information sent by the device in a "checkin" request. +message AndroidCheckinProto { + // Miliseconds since the Unix epoch of the device's last successful checkin. + optional int64 last_checkin_msec = 2; + + // The current MCC+MNC of the mobile device's current cell. + optional string cell_operator = 6; + + // The MCC+MNC of the SIM card (different from operator if the + // device is roaming, for instance). + optional string sim_operator = 7; + + // The device's current roaming state (reported starting in eclair builds). + // Currently one of "{,not}mobile-{,not}roaming", if it is present at all. + optional string roaming = 8; + + // For devices supporting multiple user profiles (which may be + // supported starting in jellybean), the ordinal number of the + // profile that is checking in. This is 0 for the primary profile + // (which can't be changed without wiping the device), and 1,2,3,... + // for additional profiles (which can be added and deleted freely). + optional int32 user_number = 9; + + // Class of device. Indicates the type of build proto + // (IosBuildProto/ChromeBuildProto/AndroidBuildProto) + // That is included in this proto + optional DeviceType type = 12 [default = DEVICE_ANDROID_OS]; + + // For devices running MCS on Chrome, build-specific characteristics + // of the browser. There are no hardware aspects (except for ChromeOS). + // This will only be populated for Chrome builds/ChromeOS devices + optional checkin_proto.ChromeBuildProto chrome_build = 13; + + // Note: Some of the Android specific optional fields were skipped to limit + // the protobuf definition. + // Next 14 +} + +// enum values correspond to the type of device. +// Used in the AndroidCheckinProto and Device proto. +enum DeviceType { + // Android Device + DEVICE_ANDROID_OS = 1; + + // Apple IOS device + DEVICE_IOS_OS = 2; + + // Chrome browser - Not Chrome OS. No hardware records. + DEVICE_CHROME_BROWSER = 3; + + // Chrome OS + DEVICE_CHROME_OS = 4; +} + +// A concrete name/value pair sent to the device's Gservices database. +message GservicesSetting { + required bytes name = 1; + required bytes value = 2; +} + +// Devices send this every few hours to tell us how they're doing. +message AndroidCheckinRequest { + // IMEI (used by GSM phones) is sent and stored as 15 decimal + // digits; the 15th is a check digit. + optional string imei = 1; // IMEI, reported but not logged. + + // MEID (used by CDMA phones) is sent and stored as 14 hexadecimal + // digits (no check digit). + optional string meid = 10; // MEID, reported but not logged. + + // MAC address (used by non-phone devices). 12 hexadecimal digits; + // no separators (eg "0016E6513AC2", not "00:16:E6:51:3A:C2"). + repeated string mac_addr = 9; // MAC address, reported but not logged. + + // An array parallel to mac_addr, describing the type of interface. + // Currently accepted values: "wifi", "ethernet", "bluetooth". If + // not present, "wifi" is assumed. + repeated string mac_addr_type = 19; + + // Serial number (a manufacturer-defined unique hardware + // identifier). Alphanumeric, case-insensitive. + optional string serial_number = 16; + + // Older CDMA networks use an ESN (8 hex digits) instead of an MEID. + optional string esn = 17; // ESN, reported but not logged + + optional int64 id = 2; // Android device ID, not logged + optional int64 logging_id = 7; // Pseudonymous logging ID for Sawmill + optional string digest = 3; // Digest of device provisioning, not logged. + optional string locale = 6; // Current locale in standard (xx_XX) format + required AndroidCheckinProto checkin = 4; + + // DEPRECATED, see AndroidCheckinProto.requested_group + optional string desired_build = 5; + + // Blob of data from the Market app to be passed to Market API server + optional string market_checkin = 8; + + // SID cookies of any google accounts stored on the phone. Not logged. + repeated string account_cookie = 11; + + // Time zone. Not currently logged. + optional string time_zone = 12; + + // Security token used to validate the checkin request. + // Required for android IDs issued to Froyo+ devices, not for legacy IDs. + optional fixed64 security_token = 13; + + // Version of checkin protocol. + // + // There are currently two versions: + // + // - version field missing: android IDs are assigned based on + // hardware identifiers. unsecured in the sense that you can + // "unregister" someone's phone by sending a registration request + // with their IMEI/MEID/MAC. + // + // - version=2: android IDs are assigned randomly. The device is + // sent a security token that must be included in all future + // checkins for that android id. + // + // - version=3: same as version 2, but the 'fragment' field is + // provided, and the device understands incremental updates to the + // gservices table (ie, only returning the keys whose values have + // changed.) + // + // (version=1 was skipped to avoid confusion with the "missing" + // version field that is effectively version 1.) + optional int32 version = 14; + + // OTA certs accepted by device (base-64 SHA-1 of cert files). Not + // logged. + repeated string ota_cert = 15; + + // Honeycomb and newer devices send configuration data with their checkin. + // optional DeviceConfigurationProto device_configuration = 18; + + // A single CheckinTask on the device may lead to multiple checkin + // requests if there is too much log data to upload in a single + // request. For version 3 and up, this field will be filled in with + // the number of the request, starting with 0. + optional int32 fragment = 20; + + // For devices supporting multiple users, the name of the current + // profile (they all check in independently, just as if they were + // multiple physical devices). This may not be set, even if the + // device is using multiuser. (checkin.user_number should be set to + // the ordinal of the user.) + optional string user_name = 21; + + // For devices supporting multiple user profiles, the serial number + // for the user checking in. Not logged. May not be set, even if + // the device supportes multiuser. checkin.user_number is the + // ordinal of the user (0, 1, 2, ...), which may be reused if users + // are deleted and re-created. user_serial_number is never reused + // (unless the device is wiped). + optional int32 user_serial_number = 22; + + // NEXT TAG: 23 +} + +// The response to the device. +message AndroidCheckinResponse { + required bool stats_ok = 1; // Whether statistics were recorded properly. + optional int64 time_msec = 3; // Time of day from server (Java epoch). + // repeated AndroidIntentProto intent = 2; + + // Provisioning is sent if the request included an obsolete digest. + // + // For version <= 2, 'digest' contains the digest that should be + // sent back to the server on the next checkin, and 'setting' + // contains the entire gservices table (which replaces the entire + // current table on the device). + // + // for version >= 3, 'digest' will be absent. If 'settings_diff' + // is false, then 'setting' contains the entire table, as in version + // 2. If 'settings_diff' is true, then 'delete_setting' contains + // the keys to delete, and 'setting' contains only keys to be added + // or for which the value has changed. All other keys in the + // current table should be left untouched. If 'settings_diff' is + // absent, don't touch the existing gservices table. + // + optional string digest = 4; + optional bool settings_diff = 9; + repeated string delete_setting = 10; + repeated GservicesSetting setting = 5; + + optional bool market_ok = 6; // If Market got the market_checkin data OK. + + optional fixed64 android_id = 7; // From the request, or newly assigned + optional fixed64 security_token = 8; // The associated security token + + optional string version_info = 11; + // NEXT TAG: 12 +} + +message HeartbeatPing { + optional int32 stream_id = 1; + optional int32 last_stream_id_received = 2; + optional int64 status = 3; +} + +/** + TAG: 1 + */ +message HeartbeatAck { + optional int32 stream_id = 1; + optional int32 last_stream_id_received = 2; + optional int64 status = 3; +} + +message ErrorInfo { + required int32 code = 1; + optional string message = 2; + optional string type = 3; + optional Extension extension = 4; +} + +// MobileSettings class. +// "u:f", "u:b", "u:s" - multi user devices reporting foreground, background +// and stopped users. +// hbping: heatbeat ping interval +// rmq2v: include explicit stream IDs + +message Setting { + required string name = 1; + required string value = 2; +} + +message HeartbeatStat { + required string ip = 1; + required bool timeout = 2; + required int32 interval_ms = 3; +} + +message HeartbeatConfig { + optional bool upload_stat = 1; + optional string ip = 2; + optional int32 interval_ms = 3; +} + +// ClientEvents are used to inform the server of failed and successful +// connections. +message ClientEvent { + enum Type { + UNKNOWN = 0; + // Count of discarded events if the buffer filled up and was trimmed. + DISCARDED_EVENTS = 1; + // Failed connection event: the connection failed to be established or we + // had a login error. + FAILED_CONNECTION = 2; + // Successful connection event: information about the last successful + // connection, including the time at which it was established. + SUCCESSFUL_CONNECTION = 3; + } + + // Common fields [1-99] + optional Type type = 1; + + // Fields for DISCARDED_EVENTS messages [100-199] + optional uint32 number_discarded_events = 100; + + // Fields for FAILED_CONNECTION and SUCCESSFUL_CONNECTION messages [200-299] + // Network type is a value in net::NetworkChangeNotifier::ConnectionType. + optional int32 network_type = 200; + // Reserved for network_port. + reserved 201; + optional uint64 time_connection_started_ms = 202; + optional uint64 time_connection_ended_ms = 203; + // Error code should be a net::Error value. + optional int32 error_code = 204; + + // Fields for SUCCESSFUL_CONNECTION messages [300-399] + optional uint64 time_connection_established_ms = 300; +} + +/** + TAG: 2 + */ +message LoginRequest { + enum AuthService { + ANDROID_ID = 2; + } + required string id = 1; // Must be present ( proto required ), may be empty + // string. + // mcs.android.com. + required string domain = 2; + // Decimal android ID + required string user = 3; + + required string resource = 4; + + // Secret + required string auth_token = 5; + + // Format is: android-HEX_DEVICE_ID + // The user is the decimal value. + optional string device_id = 6; + + // RMQ1 - no longer used + optional int64 last_rmq_id = 7; + + repeated Setting setting = 8; + //optional int32 compress = 9; + repeated string received_persistent_id = 10; + + // Replaced by "rmq2v" setting + // optional bool include_stream_ids = 11; + + optional bool adaptive_heartbeat = 12; + optional HeartbeatStat heartbeat_stat = 13; + // Must be true. + optional bool use_rmq2 = 14; + optional int64 account_id = 15; + + // ANDROID_ID = 2 + optional AuthService auth_service = 16; + + optional int32 network_type = 17; + optional int64 status = 18; + + // 19, 20, and 21 are not currently populated by Chrome. + reserved 19, 20, 21; + + // Events recorded on the client after the last successful connection. + repeated ClientEvent client_event = 22; +} + +/** + * TAG: 3 + */ +message LoginResponse { + required string id = 1; + // Not used. + optional string jid = 2; + // Null if login was ok. + optional ErrorInfo error = 3; + repeated Setting setting = 4; + optional int32 stream_id = 5; + // Should be "1" + optional int32 last_stream_id_received = 6; + optional HeartbeatConfig heartbeat_config = 7; + // used by the client to synchronize with the server timestamp. + optional int64 server_timestamp = 8; +} + +message StreamErrorStanza { + required string type = 1; + optional string text = 2; +} + +/** + * TAG: 4 + */ +message Close { +} + +message Extension { + // 12: SelectiveAck + // 13: StreamAck + required int32 id = 1; + required bytes data = 2; +} + +/** + * TAG: 7 + * IqRequest must contain a single extension. IqResponse may contain 0 or 1 + * extensions. + */ +message IqStanza { + enum IqType { + GET = 0; + SET = 1; + RESULT = 2; + IQ_ERROR = 3; + } + + optional int64 rmq_id = 1; + required IqType type = 2; + required string id = 3; + optional string from = 4; + optional string to = 5; + optional ErrorInfo error = 6; + + // Only field used in the 38+ protocol (besides common last_stream_id_received, status, rmq_id) + optional Extension extension = 7; + + optional string persistent_id = 8; + optional int32 stream_id = 9; + optional int32 last_stream_id_received = 10; + optional int64 account_id = 11; + optional int64 status = 12; +} + +message AppData { + required string key = 1; + required string value = 2; +} + +/** + * TAG: 8 + */ +message DataMessageStanza { + // Not used. + // optional int64 rmq_id = 1; + + // This is the message ID, set by client, DMP.9 (message_id) + optional string id = 2; + + // Project ID of the sender, DMP.1 + required string from = 3; + + // Part of DMRequest - also the key in DataMessageProto. + optional string to = 4; + + // Package name. DMP.2 + required string category = 5; + + // The collapsed key, DMP.3 + optional string token = 6; + + // User data + GOOGLE. prefixed special entries, DMP.4 + repeated AppData app_data = 7; + + // Not used. + optional bool from_trusted_server = 8; + + // Part of the ACK protocol, returned in DataMessageResponse on server side. + // It's part of the key of DMP. + optional string persistent_id = 9; + + // In-stream ack. Increments on each message sent - a bit redundant + // Not used in DMP/DMR. + optional int32 stream_id = 10; + optional int32 last_stream_id_received = 11; + + // Not used. + // optional string permission = 12; + + // Sent by the device shortly after registration. + optional string reg_id = 13; + + // Not used. + // optional string pkg_signature = 14; + // Not used. + // optional string client_id = 15; + + // serial number of the target user, DMP.8 + // It is the 'serial number' according to user manager. + optional int64 device_user_id = 16; + + // Time to live, in seconds. + optional int32 ttl = 17; + // Timestamp ( according to client ) when message was sent by app, in seconds + optional int64 sent = 18; + + // How long has the message been queued before the flush, in seconds. + // This is needed to account for the time difference between server and + // client: server should adjust 'sent' based on its 'receive' time. + optional int32 queued = 19; + + optional int64 status = 20; + + // Optional field containing the binary payload of the message. + optional bytes raw_data = 21; + + // Not used. + // The maximum delay of the message, in seconds. + // optional int32 max_delay = 22; + + // Not used. + // How long the message was delayed before it was sent, in seconds. + // optional int32 actual_delay = 23; + + // If set the server requests immediate ack. Used for important messages and + // for testing. + optional bool immediate_ack = 24; + + // Not used. + // Enables message receipts from MCS/GCM back to CCS clients + // optional bool delivery_receipt_requested = 25; +} + +/** + Included in IQ with ID 13, sent from client or server after 10 unconfirmed + messages. + */ +message StreamAck { + // No last_streamid_received required. This is included within an IqStanza, + // which includes the last_stream_id_received. +} + +/** + Included in IQ sent after LoginResponse from server with ID 12. +*/ +message SelectiveAck { + repeated string id = 1; +} \ No newline at end of file diff --git a/proto/signal.proto b/proto/signal.proto new file mode 100644 index 000000000..2b36a720b --- /dev/null +++ b/proto/signal.proto @@ -0,0 +1,151 @@ +syntax = "proto2"; + +message SessionStructure { + message Chain { + optional bytes senderRatchetKey = 1; + optional bytes senderRatchetKeyPrivate = 2; + + message ChainKey { + optional uint32 index = 1; + optional bytes key = 2; + } + + optional ChainKey chainKey = 3; + + message MessageKey { + optional uint32 index = 1; + optional bytes cipherKey = 2; + optional bytes macKey = 3; + optional bytes iv = 4; + } + + repeated MessageKey messageKeys = 4; + } + + message PendingKeyExchange { + optional uint32 sequence = 1; + optional bytes localBaseKey = 2; + optional bytes localBaseKeyPrivate = 3; + optional bytes localRatchetKey = 4; + optional bytes localRatchetKeyPrivate = 5; + optional bytes localIdentityKey = 7; + optional bytes localIdentityKeyPrivate = 8; + } + + message PendingPreKey { + optional uint32 preKeyId = 1; + optional int32 signedPreKeyId = 3; + optional bytes baseKey = 2; + } + + optional uint32 sessionVersion = 1; + optional bytes localIdentityPublic = 2; + optional bytes remoteIdentityPublic = 3; + + optional bytes rootKey = 4; + optional uint32 previousCounter = 5; + + optional Chain senderChain = 6; + repeated Chain receiverChains = 7; + + optional PendingKeyExchange pendingKeyExchange = 8; + optional PendingPreKey pendingPreKey = 9; + + optional uint32 remoteRegistrationId = 10; + optional uint32 localRegistrationId = 11; + + optional bool needsRefresh = 12; + optional bytes aliceBaseKey = 13; +} + +message RecordStructure { + optional SessionStructure currentSession = 1; + repeated SessionStructure previousSessions = 2; +} + +message PreKeyRecordStructure { + optional uint32 id = 1; + optional bytes publicKey = 2; + optional bytes privateKey = 3; +} + +message SignedPreKeyRecordStructure { + optional uint32 id = 1; + optional bytes publicKey = 2; + optional bytes privateKey = 3; + optional bytes signature = 4; + optional fixed64 timestamp = 5; +} + +message IdentityKeyPairStructure { + optional bytes publicKey = 1; + optional bytes privateKey = 2; +} + +message SenderKeyStateStructure { + message SenderChainKey { + optional uint32 iteration = 1; + optional bytes seed = 2; + } + + message SenderMessageKey { + optional uint32 iteration = 1; + optional bytes seed = 2; + } + + message SenderSigningKey { + optional bytes public = 1; + optional bytes private = 2; + } + + optional uint32 senderKeyId = 1; + optional SenderChainKey senderChainKey = 2; + optional SenderSigningKey senderSigningKey = 3; + repeated SenderMessageKey senderMessageKeys = 4; +} + +message SenderKeyRecordStructure { + repeated SenderKeyStateStructure senderKeyStates = 1; +} + +message SignalMessage { + optional bytes ratchetKey = 1; + optional uint32 counter = 2; + optional uint32 previousCounter = 3; + optional bytes ciphertext = 4; +} + +message PreKeySignalMessage { + optional uint32 registrationId = 5; + optional uint32 preKeyId = 1; + optional uint32 signedPreKeyId = 6; + optional bytes baseKey = 2; + optional bytes identityKey = 3; + optional bytes message = 4; // SignalMessage +} + +message KeyExchangeMessage { + optional uint32 id = 1; + optional bytes baseKey = 2; + optional bytes ratchetKey = 3; + optional bytes identityKey = 4; + optional bytes baseKeySignature = 5; +} + +message SenderKeyMessage { + optional uint32 id = 1; + optional uint32 iteration = 2; + optional bytes ciphertext = 3; +} + +message SenderKeyDistributionMessage { + optional uint32 id = 1; + optional uint32 iteration = 2; + optional bytes chainKey = 3; + optional bytes signingKey = 4; +} + +message DeviceConsistencyCodeMessage { + optional uint32 generation = 1; + optional bytes signature = 2; +} \ No newline at end of file diff --git a/proto/whatsapp.proto b/proto/whatsapp.proto new file mode 100644 index 000000000..9ff3abfc7 --- /dev/null +++ b/proto/whatsapp.proto @@ -0,0 +1,3351 @@ +syntax = "proto2"; + +package it.auties.whatsapp.model.unsupported; + + +message ADVDeviceIdentity { + optional uint32 rawId = 1; + optional uint64 timestamp = 2; + optional uint32 keyIndex = 3; + optional ADVEncryptionType accountType = 4; + optional ADVEncryptionType deviceType = 5; +} + +enum ADVEncryptionType { + E2EE = 0; + HOSTED = 1; +} +message ADVKeyIndexList { + optional uint32 rawId = 1; + optional uint64 timestamp = 2; + optional uint32 currentIndex = 3; + repeated uint32 validIndexes = 4 [packed=true]; + optional ADVEncryptionType accountType = 5; +} + +message ADVSignedDeviceIdentity { + optional bytes details = 1; + optional bytes accountSignatureKey = 2; + optional bytes accountSignature = 3; + optional bytes deviceSignature = 4; +} + +message ADVSignedDeviceIdentityHMAC { + optional bytes details = 1; + optional bytes hmac = 2; + optional ADVEncryptionType accountType = 3; +} + +message ADVSignedKeyIndexList { + optional bytes details = 1; + optional bytes accountSignature = 2; + optional bytes accountSignatureKey = 3; +} + +message ActionLink { + optional string url = 1; + optional string buttonTitle = 2; +} + +message AutoDownloadSettings { + optional bool downloadImages = 1; + optional bool downloadAudio = 2; + optional bool downloadVideo = 3; + optional bool downloadDocuments = 4; +} + +message AvatarUserSettings { + optional string fbid = 1; + optional string password = 2; +} + +message BizAccountLinkInfo { + optional uint64 whatsappBizAcctFbid = 1; + optional string whatsappAcctNumber = 2; + optional uint64 issueTime = 3; + optional HostStorageType hostStorage = 4; + optional AccountType accountType = 5; + enum AccountType { + ENTERPRISE = 0; + } + enum HostStorageType { + ON_PREMISE = 0; + FACEBOOK = 1; + } +} + +message BizAccountPayload { + optional VerifiedNameCertificate vnameCert = 1; + optional bytes bizAcctLinkInfo = 2; +} + +message BizIdentityInfo { + optional VerifiedLevelValue vlevel = 1; + optional VerifiedNameCertificate vnameCert = 2; + optional bool signed = 3; + optional bool revoked = 4; + optional HostStorageType hostStorage = 5; + optional ActualActorsType actualActors = 6; + optional uint64 privacyModeTs = 7; + optional uint64 featureControls = 8; + enum ActualActorsType { + SELF = 0; + BSP = 1; + } + enum HostStorageType { + ON_PREMISE = 0; + FACEBOOK = 1; + } + enum VerifiedLevelValue { + UNKNOWN = 0; + LOW = 1; + HIGH = 2; + } +} + +message BotAvatarMetadata { + optional uint32 sentiment = 1; + optional string behaviorGraph = 2; + optional uint32 action = 3; + optional uint32 intensity = 4; + optional uint32 wordCount = 5; +} + +message BotMetadata { + optional BotAvatarMetadata avatarMetadata = 1; + optional string personaId = 2; + optional BotPluginMetadata pluginMetadata = 3; + optional BotSuggestedPromptMetadata suggestedPromptMetadata = 4; + optional string invokerJid = 5; +} + +message BotPluginMetadata { + optional SearchProvider provider = 1; + optional PluginType pluginType = 2; + optional string thumbnailCdnUrl = 3; + optional string profilePhotoCdnUrl = 4; + optional string searchProviderUrl = 5; + optional uint32 referenceIndex = 6; + optional uint32 expectedLinksCount = 7; + optional uint32 pluginVersion = 8; + optional string searchQuery = 9; + enum PluginType { + REELS = 1; + SEARCH = 2; + } + enum SearchProvider { + BING = 1; + GOOGLE = 2; + } +} + +message BotSuggestedPromptMetadata { + repeated string suggestedPrompts = 1; + optional uint32 selectedPromptIndex = 2; +} + +message CallLogRecord { + optional CallResult callResult = 1; + optional bool isDndMode = 2; + optional SilenceReason silenceReason = 3; + optional int64 duration = 4; + optional int64 startTime = 5; + optional bool isIncoming = 6; + optional bool isVideo = 7; + optional bool isCallLink = 8; + optional string callLinkToken = 9; + optional string scheduledCallId = 10; + optional string callId = 11; + optional string callCreatorJid = 12; + optional string groupJid = 13; + repeated ParticipantInfo participants = 14; + optional CallType callType = 15; + enum CallResult { + CONNECTED = 0; + REJECTED = 1; + CANCELLED = 2; + ACCEPTEDELSEWHERE = 3; + MISSED = 4; + INVALID = 5; + UNAVAILABLE = 6; + UPCOMING = 7; + FAILED = 8; + ABANDONED = 9; + ONGOING = 10; + } + enum CallType { + REGULAR = 0; + SCHEDULED_CALL = 1; + VOICE_CHAT = 2; + } + message ParticipantInfo { + optional string userJid = 1; + optional CallLogRecord.CallResult callResult = 2; + } + + enum SilenceReason { + NONE = 0; + SCHEDULED = 1; + PRIVACY = 2; + LIGHTWEIGHT = 3; + } +} + +message CertChain { + optional NoiseCertificate leaf = 1; + optional NoiseCertificate intermediate = 2; + message NoiseCertificate { + optional bytes details = 1; + optional bytes signature = 2; + message Details { + optional uint32 serial = 1; + optional uint32 issuerSerial = 2; + optional bytes key = 3; + optional uint64 notBefore = 4; + optional uint64 notAfter = 5; + } + + } + +} + +message ChatRowOpaqueData { + optional DraftMessage draftMessage = 1; + message DraftMessage { + optional string text = 1; + optional string omittedUrl = 2; + optional CtwaContextLinkData ctwaContextLinkData = 3; + optional CtwaContextData ctwaContext = 4; + optional int64 timestamp = 5; + message CtwaContextData { + optional string conversionSource = 1; + optional bytes conversionData = 2; + optional string sourceUrl = 3; + optional string sourceId = 4; + optional string sourceType = 5; + optional string title = 6; + optional string description = 7; + optional string thumbnail = 8; + optional string thumbnailUrl = 9; + optional ContextInfoExternalAdReplyInfoMediaType mediaType = 10; + optional string mediaUrl = 11; + optional bool isSuspiciousLink = 12; + enum ContextInfoExternalAdReplyInfoMediaType { + NONE = 0; + IMAGE = 1; + VIDEO = 2; + } + } + + message CtwaContextLinkData { + optional string context = 1; + optional string sourceUrl = 2; + optional string icebreaker = 3; + optional string phone = 4; + } + + } + +} + +message ClientPayload { + optional uint64 username = 1; + optional bool passive = 3; + optional UserAgent userAgent = 5; + optional WebInfo webInfo = 6; + optional string pushName = 7; + optional sfixed32 sessionId = 9; + optional bool shortConnect = 10; + optional ConnectType connectType = 12; + optional ConnectReason connectReason = 13; + repeated int32 shards = 14; + optional DNSSource dnsSource = 15; + optional uint32 connectAttemptCount = 16; + optional uint32 device = 18; + optional DevicePairingRegistrationData devicePairingData = 19; + optional Product product = 20; + optional bytes fbCat = 21; + optional bytes fbUserAgent = 22; + optional bool oc = 23; + optional int32 lc = 24; + optional IOSAppExtension iosAppExtension = 30; + optional uint64 fbAppId = 31; + optional bytes fbDeviceId = 32; + optional bool pull = 33; + optional bytes paddingBytes = 34; + optional int32 yearClass = 36; + optional int32 memClass = 37; + optional InteropData interopData = 38; + enum ConnectReason { + PUSH = 0; + USER_ACTIVATED = 1; + SCHEDULED = 2; + ERROR_RECONNECT = 3; + NETWORK_SWITCH = 4; + PING_RECONNECT = 5; + UNKNOWN = 6; + } + enum ConnectType { + CELLULAR_UNKNOWN = 0; + WIFI_UNKNOWN = 1; + CELLULAR_EDGE = 100; + CELLULAR_IDEN = 101; + CELLULAR_UMTS = 102; + CELLULAR_EVDO = 103; + CELLULAR_GPRS = 104; + CELLULAR_HSDPA = 105; + CELLULAR_HSUPA = 106; + CELLULAR_HSPA = 107; + CELLULAR_CDMA = 108; + CELLULAR_1XRTT = 109; + CELLULAR_EHRPD = 110; + CELLULAR_LTE = 111; + CELLULAR_HSPAP = 112; + } + message DNSSource { + optional DNSResolutionMethod dnsMethod = 15; + optional bool appCached = 16; + enum DNSResolutionMethod { + SYSTEM = 0; + GOOGLE = 1; + HARDCODED = 2; + OVERRIDE = 3; + FALLBACK = 4; + } + } + + message DevicePairingRegistrationData { + optional bytes eRegid = 1; + optional bytes eKeytype = 2; + optional bytes eIdent = 3; + optional bytes eSkeyId = 4; + optional bytes eSkeyVal = 5; + optional bytes eSkeySig = 6; + optional bytes buildHash = 7; + optional bytes deviceProps = 8; + } + + enum IOSAppExtension { + SHARE_EXTENSION = 0; + SERVICE_EXTENSION = 1; + INTENTS_EXTENSION = 2; + } + message InteropData { + optional uint64 accountId = 1; + optional bytes token = 2; + } + + enum Product { + WHATSAPP = 0; + MESSENGER = 1; + INTEROP = 2; + INTEROP_MSGR = 3; + } + message UserAgent { + optional Platform platform = 1; + optional AppVersion appVersion = 2; + optional string mcc = 3; + optional string mnc = 4; + optional string osVersion = 5; + optional string manufacturer = 6; + optional string device = 7; + optional string osBuildNumber = 8; + optional string phoneId = 9; + optional ReleaseChannel releaseChannel = 10; + optional string localeLanguageIso6391 = 11; + optional string localeCountryIso31661Alpha2 = 12; + optional string deviceBoard = 13; + optional string deviceExpId = 14; + optional DeviceType deviceType = 15; + message AppVersion { + optional uint32 primary = 1; + optional uint32 secondary = 2; + optional uint32 tertiary = 3; + optional uint32 quaternary = 4; + optional uint32 quinary = 5; + } + + enum DeviceType { + PHONE = 0; + TABLET = 1; + DESKTOP = 2; + WEARABLE = 3; + VR = 4; + } + enum Platform { + ANDROID = 0; + IOS = 1; + WINDOWS_PHONE = 2; + BLACKBERRY = 3; + BLACKBERRYX = 4; + S40 = 5; + S60 = 6; + PYTHON_CLIENT = 7; + TIZEN = 8; + ENTERPRISE = 9; + SMB_ANDROID = 10; + KAIOS = 11; + SMB_IOS = 12; + WINDOWS = 13; + WEB = 14; + PORTAL = 15; + GREEN_ANDROID = 16; + GREEN_IPHONE = 17; + BLUE_ANDROID = 18; + BLUE_IPHONE = 19; + FBLITE_ANDROID = 20; + MLITE_ANDROID = 21; + IGLITE_ANDROID = 22; + PAGE = 23; + MACOS = 24; + OCULUS_MSG = 25; + OCULUS_CALL = 26; + MILAN = 27; + CAPI = 28; + WEAROS = 29; + ARDEVICE = 30; + VRDEVICE = 31; + BLUE_WEB = 32; + IPAD = 33; + TEST = 34; + SMART_GLASSES = 35; + } + enum ReleaseChannel { + RELEASE = 0; + BETA = 1; + ALPHA = 2; + DEBUG = 3; + } + } + + message WebInfo { + optional string refToken = 1; + optional string version = 2; + optional WebdPayload webdPayload = 3; + optional WebSubPlatform webSubPlatform = 4; + enum WebSubPlatform { + WEB_BROWSER = 0; + APP_STORE = 1; + WIN_STORE = 2; + DARWIN = 3; + WIN32 = 4; + } + message WebdPayload { + optional bool usesParticipantInKey = 1; + optional bool supportsStarredMessages = 2; + optional bool supportsDocumentMessages = 3; + optional bool supportsUrlMessages = 4; + optional bool supportsMediaRetry = 5; + optional bool supportsE2EImage = 6; + optional bool supportsE2EVideo = 7; + optional bool supportsE2EAudio = 8; + optional bool supportsE2EDocument = 9; + optional string documentTypes = 10; + optional bytes features = 11; + } + + } + +} + +message CommentMetadata { + optional MessageKey commentParentKey = 1; + optional uint32 replyCount = 2; +} + +message ContextInfo { + optional string stanzaId = 1; + optional string participant = 2; + optional Message quotedMessage = 3; + optional string remoteJid = 4; + repeated string mentionedJid = 15; + optional string conversionSource = 18; + optional bytes conversionData = 19; + optional uint32 conversionDelaySeconds = 20; + optional uint32 forwardingScore = 21; + optional bool isForwarded = 22; + optional AdReplyInfo quotedAd = 23; + optional MessageKey placeholderKey = 24; + optional uint32 expiration = 25; + optional int64 ephemeralSettingTimestamp = 26; + optional bytes ephemeralSharedSecret = 27; + optional ExternalAdReplyInfo externalAdReply = 28; + optional string entryPointConversionSource = 29; + optional string entryPointConversionApp = 30; + optional uint32 entryPointConversionDelaySeconds = 31; + optional DisappearingMode disappearingMode = 32; + optional ActionLink actionLink = 33; + optional string groupSubject = 34; + optional string parentGroupJid = 35; + optional string trustBannerType = 37; + optional uint32 trustBannerAction = 38; + optional bool isSampled = 39; + repeated GroupMention groupMentions = 40; + optional UTMInfo utm = 41; + optional ForwardedNewsletterMessageInfo forwardedNewsletterMessageInfo = 43; + optional BusinessMessageForwardInfo businessMessageForwardInfo = 44; + optional string smbClientCampaignId = 45; + optional string smbServerCampaignId = 46; + optional DataSharingContext dataSharingContext = 47; + message AdReplyInfo { + optional string advertiserName = 1; + optional MediaType mediaType = 2; + optional bytes jpegThumbnail = 16; + optional string caption = 17; + enum MediaType { + NONE = 0; + IMAGE = 1; + VIDEO = 2; + } + } + + message BusinessMessageForwardInfo { + optional string businessOwnerJid = 1; + } + + message DataSharingContext { + optional bool showMmDisclosure = 1; + } + + message ExternalAdReplyInfo { + optional string title = 1; + optional string body = 2; + optional MediaType mediaType = 3; + optional string thumbnailUrl = 4; + optional string mediaUrl = 5; + optional bytes thumbnail = 6; + optional string sourceType = 7; + optional string sourceId = 8; + optional string sourceUrl = 9; + optional bool containsAutoReply = 10; + optional bool renderLargerThumbnail = 11; + optional bool showAdAttribution = 12; + optional string ctwaClid = 13; + optional string ref = 14; + enum MediaType { + NONE = 0; + IMAGE = 1; + VIDEO = 2; + } + } + + message ForwardedNewsletterMessageInfo { + optional string newsletterJid = 1; + optional int32 serverMessageId = 2; + optional string newsletterName = 3; + optional ContentType contentType = 4; + optional string accessibilityText = 5; + enum ContentType { + UPDATE = 1; + UPDATE_CARD = 2; + LINK_CARD = 3; + } + } + + message UTMInfo { + optional string utmSource = 1; + optional string utmCampaign = 2; + } + +} + +message Conversation { + required string id = 1; + repeated HistorySyncMsg messages = 2; + optional string newJid = 3; + optional string oldJid = 4; + optional uint64 lastMsgTimestamp = 5; + optional uint32 unreadCount = 6; + optional bool readOnly = 7; + optional bool endOfHistoryTransfer = 8; + optional uint32 ephemeralExpiration = 9; + optional int64 ephemeralSettingTimestamp = 10; + optional EndOfHistoryTransferType endOfHistoryTransferType = 11; + optional uint64 conversationTimestamp = 12; + optional string name = 13; + optional string pHash = 14; + optional bool notSpam = 15; + optional bool archived = 16; + optional DisappearingMode disappearingMode = 17; + optional uint32 unreadMentionCount = 18; + optional bool markedAsUnread = 19; + repeated GroupParticipant participant = 20; + optional bytes tcToken = 21; + optional uint64 tcTokenTimestamp = 22; + optional bytes contactPrimaryIdentityKey = 23; + optional uint32 pinned = 24; + optional uint64 muteEndTime = 25; + optional WallpaperSettings wallpaper = 26; + optional MediaVisibility mediaVisibility = 27; + optional uint64 tcTokenSenderTimestamp = 28; + optional bool suspended = 29; + optional bool terminated = 30; + optional uint64 createdAt = 31; + optional string createdBy = 32; + optional string description = 33; + optional bool support = 34; + optional bool isParentGroup = 35; + optional string parentGroupId = 37; + optional bool isDefaultSubgroup = 36; + optional string displayName = 38; + optional string pnJid = 39; + optional bool shareOwnPn = 40; + optional bool pnhDuplicateLidThread = 41; + optional string lidJid = 42; + optional string username = 43; + optional string lidOriginType = 44; + optional uint32 commentsCount = 45; + enum EndOfHistoryTransferType { + COMPLETE_BUT_MORE_MESSAGES_REMAIN_ON_PRIMARY = 0; + COMPLETE_AND_NO_MORE_MESSAGE_REMAIN_ON_PRIMARY = 1; + COMPLETE_ON_DEMAND_SYNC_BUT_MORE_MSG_REMAIN_ON_PRIMARY = 2; + } +} + +message DeviceConsistencyCodeMessage { + optional uint32 generation = 1; + optional bytes signature = 2; +} + +message DeviceListMetadata { + optional bytes senderKeyHash = 1; + optional uint64 senderTimestamp = 2; + repeated uint32 senderKeyIndexes = 3 [packed=true]; + optional ADVEncryptionType senderAccountType = 4; + optional ADVEncryptionType receiverAccountType = 5; + optional bytes recipientKeyHash = 8; + optional uint64 recipientTimestamp = 9; + repeated uint32 recipientKeyIndexes = 10 [packed=true]; +} + +message DeviceProps { + optional string os = 1; + optional AppVersion version = 2; + optional PlatformType platformType = 3; + optional bool requireFullSync = 4; + optional HistorySyncConfig historySyncConfig = 5; + message AppVersion { + optional uint32 primary = 1; + optional uint32 secondary = 2; + optional uint32 tertiary = 3; + optional uint32 quaternary = 4; + optional uint32 quinary = 5; + } + + message HistorySyncConfig { + optional uint32 fullSyncDaysLimit = 1; + optional uint32 fullSyncSizeMbLimit = 2; + optional uint32 storageQuotaMb = 3; + optional bool inlineInitialPayloadInE2EeMsg = 4; + optional uint32 recentSyncDaysLimit = 5; + optional bool supportCallLogHistory = 6; + optional bool supportBotUserAgentChatHistory = 7; + optional bool supportCagReactionsAndPolls = 8; + } + + enum PlatformType { + UNKNOWN = 0; + CHROME = 1; + FIREFOX = 2; + IE = 3; + OPERA = 4; + SAFARI = 5; + EDGE = 6; + DESKTOP = 7; + IPAD = 8; + ANDROID_TABLET = 9; + OHANA = 10; + ALOHA = 11; + CATALINA = 12; + TCL_TV = 13; + IOS_PHONE = 14; + IOS_CATALYST = 15; + ANDROID_PHONE = 16; + ANDROID_AMBIGUOUS = 17; + WEAR_OS = 18; + AR_WRIST = 19; + AR_DEVICE = 20; + UWP = 21; + VR = 22; + } +} + +message DisappearingMode { + optional Initiator initiator = 1; + optional Trigger trigger = 2; + optional string initiatorDeviceJid = 3; + optional bool initiatedByMe = 4; + enum Initiator { + CHANGED_IN_CHAT = 0; + INITIATED_BY_ME = 1; + INITIATED_BY_OTHER = 2; + BIZ_UPGRADE_FB_HOSTING = 3; + } + enum Trigger { + UNKNOWN = 0; + CHAT_SETTING = 1; + ACCOUNT_SETTING = 2; + BULK_CHANGE = 3; + BIZ_SUPPORTS_FB_HOSTING = 4; + } +} + +message EphemeralSetting { + optional sfixed32 duration = 1; + optional sfixed64 timestamp = 2; +} + +message EventResponse { + optional MessageKey eventResponseMessageKey = 1; + optional int64 timestampMs = 2; + optional Message.EventResponseMessage eventResponseMessage = 3; + optional bool unread = 4; +} + +message ExitCode { + optional uint64 code = 1; + optional string text = 2; +} + +message ExternalBlobReference { + optional bytes mediaKey = 1; + optional string directPath = 2; + optional string handle = 3; + optional uint64 fileSizeBytes = 4; + optional bytes fileSha256 = 5; + optional bytes fileEncSha256 = 6; +} + +message GlobalSettings { + optional WallpaperSettings lightThemeWallpaper = 1; + optional MediaVisibility mediaVisibility = 2; + optional WallpaperSettings darkThemeWallpaper = 3; + optional AutoDownloadSettings autoDownloadWiFi = 4; + optional AutoDownloadSettings autoDownloadCellular = 5; + optional AutoDownloadSettings autoDownloadRoaming = 6; + optional bool showIndividualNotificationsPreview = 7; + optional bool showGroupNotificationsPreview = 8; + optional int32 disappearingModeDuration = 9; + optional int64 disappearingModeTimestamp = 10; + optional AvatarUserSettings avatarUserSettings = 11; + optional int32 fontSize = 12; + optional bool securityNotifications = 13; + optional bool autoUnarchiveChats = 14; + optional int32 videoQualityMode = 15; + optional int32 photoQualityMode = 16; + optional NotificationSettings individualNotificationSettings = 17; + optional NotificationSettings groupNotificationSettings = 18; +} + +message GroupMention { + optional string groupJid = 1; + optional string groupSubject = 2; +} + +message GroupParticipant { + required string userJid = 1; + optional Rank rank = 2; + enum Rank { + REGULAR = 0; + ADMIN = 1; + SUPERADMIN = 2; + } +} + +message HandshakeMessage { + optional ClientHello clientHello = 2; + optional ServerHello serverHello = 3; + optional ClientFinish clientFinish = 4; + message ClientFinish { + optional bytes static = 1; + optional bytes payload = 2; + } + + message ClientHello { + optional bytes ephemeral = 1; + optional bytes static = 2; + optional bytes payload = 3; + } + + message ServerHello { + optional bytes ephemeral = 1; + optional bytes static = 2; + optional bytes payload = 3; + } + +} + +message HistorySync { + required HistorySyncType syncType = 1; + repeated Conversation conversations = 2; + repeated WebMessageInfo statusV3Messages = 3; + optional uint32 chunkOrder = 5; + optional uint32 progress = 6; + repeated Pushname pushnames = 7; + optional GlobalSettings globalSettings = 8; + optional bytes threadIdUserSecret = 9; + optional uint32 threadDsTimeframeOffset = 10; + repeated StickerMetadata recentStickers = 11; + repeated PastParticipants pastParticipants = 12; + repeated CallLogRecord callLogRecords = 13; + optional BotAIWaitListState aiWaitListState = 14; + repeated PhoneNumberToLIDMapping phoneNumberToLidMappings = 15; + enum BotAIWaitListState { + IN_WAITLIST = 0; + AI_AVAILABLE = 1; + } + enum HistorySyncType { + INITIAL_BOOTSTRAP = 0; + INITIAL_STATUS_V3 = 1; + FULL = 2; + RECENT = 3; + PUSH_NAME = 4; + NON_BLOCKING_DATA = 5; + ON_DEMAND = 6; + } +} + +message HistorySyncMsg { + optional WebMessageInfo message = 1; + optional uint64 msgOrderId = 2; +} + +message HydratedTemplateButton { + optional uint32 index = 4; + oneof hydratedButton { + HydratedTemplateButton.HydratedQuickReplyButton quickReplyButton = 1; + HydratedTemplateButton.HydratedURLButton urlButton = 2; + HydratedTemplateButton.HydratedCallButton callButton = 3; + } + message HydratedCallButton { + optional string displayText = 1; + optional string phoneNumber = 2; + } + + message HydratedQuickReplyButton { + optional string displayText = 1; + optional string id = 2; + } + + message HydratedURLButton { + optional string displayText = 1; + optional string url = 2; + optional string consentedUsersUrl = 3; + optional WebviewPresentationType webviewPresentation = 4; + enum WebviewPresentationType { + FULL = 1; + TALL = 2; + COMPACT = 3; + } + } + +} + +message IdentityKeyPairStructure { + optional bytes publicKey = 1; + optional bytes privateKey = 2; +} + +message InteractiveAnnotation { + repeated Point polygonVertices = 1; + optional bool shouldSkipConfirmation = 4; + oneof action { + Location location = 2; + ContextInfo.ForwardedNewsletterMessageInfo newsletter = 3; + } +} + +message KeepInChat { + optional KeepType keepType = 1; + optional int64 serverTimestamp = 2; + optional MessageKey key = 3; + optional string deviceJid = 4; + optional int64 clientTimestampMs = 5; + optional int64 serverTimestampMs = 6; +} + +enum KeepType { + UNKNOWN = 0; + KEEP_FOR_ALL = 1; + UNDO_KEEP_FOR_ALL = 2; +} +message KeyExchangeMessage { + optional uint32 id = 1; + optional bytes baseKey = 2; + optional bytes ratchetKey = 3; + optional bytes identityKey = 4; + optional bytes baseKeySignature = 5; +} + +message KeyId { + optional bytes id = 1; +} + +message LocalizedName { + optional string lg = 1; + optional string lc = 2; + optional string verifiedName = 3; +} + +message Location { + optional double degreesLatitude = 1; + optional double degreesLongitude = 2; + optional string name = 3; +} + +message MediaData { + optional string localPath = 1; +} + +message MediaEntry { + optional bytes fileSha256 = 1; + optional bytes mediaKey = 2; + optional bytes fileEncSha256 = 3; + optional string directPath = 4; + optional int64 mediaKeyTimestamp = 5; + optional string serverMediaType = 6; + optional bytes uploadToken = 7; + optional bytes validatedTimestamp = 8; + optional bytes sidecar = 9; + optional string objectId = 10; + optional string fbid = 11; + optional DownloadableThumbnail downloadableThumbnail = 12; + optional string handle = 13; + optional string filename = 14; + optional ProgressiveJpegDetails progressiveJpegDetails = 15; + message DownloadableThumbnail { + optional bytes fileSha256 = 1; + optional bytes fileEncSha256 = 2; + optional string directPath = 3; + optional bytes mediaKey = 4; + optional int64 mediaKeyTimestamp = 5; + optional string objectId = 6; + } + + message ProgressiveJpegDetails { + repeated int64 scanLengths = 1; + optional bytes sidecar = 2; + } + +} + +message MediaNotifyMessage { + optional string expressPathUrl = 1; + optional bytes fileEncSha256 = 2; + optional uint64 fileLength = 3; +} + +message MediaRetryNotification { + optional string stanzaId = 1; + optional string directPath = 2; + optional ResultType result = 3; + enum ResultType { + GENERAL_ERROR = 0; + SUCCESS = 1; + NOT_FOUND = 2; + DECRYPTION_ERROR = 3; + } +} + +enum MediaVisibility { + DEFAULT = 0; + OFF = 1; + ON = 2; +} +message Message { + optional string conversation = 1; + optional SenderKeyDistributionMessage senderKeyDistributionMessage = 2; + optional ImageMessage imageMessage = 3; + optional ContactMessage contactMessage = 4; + optional LocationMessage locationMessage = 5; + optional ExtendedTextMessage extendedTextMessage = 6; + optional DocumentMessage documentMessage = 7; + optional AudioMessage audioMessage = 8; + optional VideoMessage videoMessage = 9; + optional Call call = 10; + optional Chat chat = 11; + optional ProtocolMessage protocolMessage = 12; + optional ContactsArrayMessage contactsArrayMessage = 13; + optional HighlyStructuredMessage highlyStructuredMessage = 14; + optional SenderKeyDistributionMessage fastRatchetKeySenderKeyDistributionMessage = 15; + optional SendPaymentMessage sendPaymentMessage = 16; + optional LiveLocationMessage liveLocationMessage = 18; + optional RequestPaymentMessage requestPaymentMessage = 22; + optional DeclinePaymentRequestMessage declinePaymentRequestMessage = 23; + optional CancelPaymentRequestMessage cancelPaymentRequestMessage = 24; + optional TemplateMessage templateMessage = 25; + optional StickerMessage stickerMessage = 26; + optional GroupInviteMessage groupInviteMessage = 28; + optional TemplateButtonReplyMessage templateButtonReplyMessage = 29; + optional ProductMessage productMessage = 30; + optional DeviceSentMessage deviceSentMessage = 31; + optional MessageContextInfo messageContextInfo = 35; + optional ListMessage listMessage = 36; + optional FutureProofMessage viewOnceMessage = 37; + optional OrderMessage orderMessage = 38; + optional ListResponseMessage listResponseMessage = 39; + optional FutureProofMessage ephemeralMessage = 40; + optional InvoiceMessage invoiceMessage = 41; + optional ButtonsMessage buttonsMessage = 42; + optional ButtonsResponseMessage buttonsResponseMessage = 43; + optional PaymentInviteMessage paymentInviteMessage = 44; + optional InteractiveMessage interactiveMessage = 45; + optional ReactionMessage reactionMessage = 46; + optional StickerSyncRMRMessage stickerSyncRmrMessage = 47; + optional InteractiveResponseMessage interactiveResponseMessage = 48; + optional PollCreationMessage pollCreationMessage = 49; + optional PollUpdateMessage pollUpdateMessage = 50; + optional KeepInChatMessage keepInChatMessage = 51; + optional FutureProofMessage documentWithCaptionMessage = 53; + optional RequestPhoneNumberMessage requestPhoneNumberMessage = 54; + optional FutureProofMessage viewOnceMessageV2 = 55; + optional EncReactionMessage encReactionMessage = 56; + optional FutureProofMessage editedMessage = 58; + optional FutureProofMessage viewOnceMessageV2Extension = 59; + optional PollCreationMessage pollCreationMessageV2 = 60; + optional ScheduledCallCreationMessage scheduledCallCreationMessage = 61; + optional FutureProofMessage groupMentionedMessage = 62; + optional PinInChatMessage pinInChatMessage = 63; + optional PollCreationMessage pollCreationMessageV3 = 64; + optional ScheduledCallEditMessage scheduledCallEditMessage = 65; + optional VideoMessage ptvMessage = 66; + optional FutureProofMessage botInvokeMessage = 67; + optional CallLogMessage callLogMesssage = 69; + optional MessageHistoryBundle messageHistoryBundle = 70; + optional EncCommentMessage encCommentMessage = 71; + optional BCallMessage bcallMessage = 72; + optional FutureProofMessage lottieStickerMessage = 74; + optional EventMessage eventMessage = 75; + optional EncEventResponseMessage encEventResponseMessage = 76; + optional CommentMessage commentMessage = 77; + optional NewsletterAdminInviteMessage newsletterAdminInviteMessage = 78; + optional ExtendedTextMessageWithParentKey extendedTextMessageWithParentKey = 79; + optional PlaceholderMessage placeholderMessage = 80; + optional SecretEncryptedMessage secretEncryptedMessage = 82; + message AppStateFatalExceptionNotification { + repeated string collectionNames = 1; + optional int64 timestamp = 2; + } + + message AppStateSyncKey { + optional Message.AppStateSyncKeyId keyId = 1; + optional Message.AppStateSyncKeyData keyData = 2; + } + + message AppStateSyncKeyData { + optional bytes keyData = 1; + optional Message.AppStateSyncKeyFingerprint fingerprint = 2; + optional int64 timestamp = 3; + } + + message AppStateSyncKeyFingerprint { + optional uint32 rawId = 1; + optional uint32 currentIndex = 2; + repeated uint32 deviceIndexes = 3 [packed=true]; + } + + message AppStateSyncKeyId { + optional bytes keyId = 1; + } + + message AppStateSyncKeyRequest { + repeated Message.AppStateSyncKeyId keyIds = 1; + } + + message AppStateSyncKeyShare { + repeated Message.AppStateSyncKey keys = 1; + } + + message AudioMessage { + optional string url = 1; + optional string mimetype = 2; + optional bytes fileSha256 = 3; + optional uint64 fileLength = 4; + optional uint32 seconds = 5; + optional bool ptt = 6; + optional bytes mediaKey = 7; + optional bytes fileEncSha256 = 8; + optional string directPath = 9; + optional int64 mediaKeyTimestamp = 10; + optional ContextInfo contextInfo = 17; + optional bytes streamingSidecar = 18; + optional bytes waveform = 19; + optional fixed32 backgroundArgb = 20; + optional bool viewOnce = 21; + } + + message BCallMessage { + optional string sessionId = 1; + optional MediaType mediaType = 2; + optional bytes masterKey = 3; + optional string caption = 4; + enum MediaType { + UNKNOWN = 0; + AUDIO = 1; + VIDEO = 2; + } + } + + message BotFeedbackMessage { + optional MessageKey messageKey = 1; + optional BotFeedbackKind kind = 2; + optional string text = 3; + optional uint64 kindNegative = 4; + optional uint64 kindPositive = 5; + enum BotFeedbackKind { + BOT_FEEDBACK_POSITIVE = 0; + BOT_FEEDBACK_NEGATIVE_GENERIC = 1; + BOT_FEEDBACK_NEGATIVE_HELPFUL = 2; + BOT_FEEDBACK_NEGATIVE_INTERESTING = 3; + BOT_FEEDBACK_NEGATIVE_ACCURATE = 4; + BOT_FEEDBACK_NEGATIVE_SAFE = 5; + BOT_FEEDBACK_NEGATIVE_OTHER = 6; + BOT_FEEDBACK_NEGATIVE_REFUSED = 7; + BOT_FEEDBACK_NEGATIVE_NOT_VISUALLY_APPEALING = 8; + BOT_FEEDBACK_NEGATIVE_NOT_RELEVANT_TO_TEXT = 9; + } + enum BotFeedbackKindMultipleNegative { + BOT_FEEDBACK_MULTIPLE_NEGATIVE_GENERIC = 1; + BOT_FEEDBACK_MULTIPLE_NEGATIVE_HELPFUL = 2; + BOT_FEEDBACK_MULTIPLE_NEGATIVE_INTERESTING = 4; + BOT_FEEDBACK_MULTIPLE_NEGATIVE_ACCURATE = 8; + BOT_FEEDBACK_MULTIPLE_NEGATIVE_SAFE = 16; + BOT_FEEDBACK_MULTIPLE_NEGATIVE_OTHER = 32; + BOT_FEEDBACK_MULTIPLE_NEGATIVE_REFUSED = 64; + BOT_FEEDBACK_MULTIPLE_NEGATIVE_NOT_VISUALLY_APPEALING = 128; + BOT_FEEDBACK_MULTIPLE_NEGATIVE_NOT_RELEVANT_TO_TEXT = 256; + } + enum BotFeedbackKindMultiplePositive { + BOT_FEEDBACK_MULTIPLE_POSITIVE_GENERIC = 1; + } + } + + message ButtonsMessage { + optional string contentText = 6; + optional string footerText = 7; + optional ContextInfo contextInfo = 8; + repeated Button buttons = 9; + optional HeaderType headerType = 10; + oneof header { + string text = 1; + Message.DocumentMessage documentMessage = 2; + Message.ImageMessage imageMessage = 3; + Message.VideoMessage videoMessage = 4; + Message.LocationMessage locationMessage = 5; + } + message Button { + optional string buttonId = 1; + optional ButtonText buttonText = 2; + optional Type type = 3; + optional NativeFlowInfo nativeFlowInfo = 4; + message ButtonText { + optional string displayText = 1; + } + + message NativeFlowInfo { + optional string name = 1; + optional string paramsJson = 2; + } + + enum Type { + UNKNOWN = 0; + RESPONSE = 1; + NATIVE_FLOW = 2; + } + } + + enum HeaderType { + UNKNOWN = 0; + EMPTY = 1; + TEXT = 2; + DOCUMENT = 3; + IMAGE = 4; + VIDEO = 5; + LOCATION = 6; + } + } + + message ButtonsResponseMessage { + optional string selectedButtonId = 1; + optional ContextInfo contextInfo = 3; + optional Type type = 4; + oneof response { + string selectedDisplayText = 2; + } + enum Type { + UNKNOWN = 0; + DISPLAY_TEXT = 1; + } + } + + message Call { + optional bytes callKey = 1; + optional string conversionSource = 2; + optional bytes conversionData = 3; + optional uint32 conversionDelaySeconds = 4; + } + + message CallLogMessage { + optional bool isVideo = 1; + optional CallOutcome callOutcome = 2; + optional int64 durationSecs = 3; + optional CallType callType = 4; + repeated CallParticipant participants = 5; + enum CallOutcome { + CONNECTED = 0; + MISSED = 1; + FAILED = 2; + REJECTED = 3; + ACCEPTED_ELSEWHERE = 4; + ONGOING = 5; + SILENCED_BY_DND = 6; + SILENCED_UNKNOWN_CALLER = 7; + } + message CallParticipant { + optional string jid = 1; + optional Message.CallLogMessage.CallOutcome callOutcome = 2; + } + + enum CallType { + REGULAR = 0; + SCHEDULED_CALL = 1; + VOICE_CHAT = 2; + } + } + + message CancelPaymentRequestMessage { + optional MessageKey key = 1; + } + + message Chat { + optional string displayName = 1; + optional string id = 2; + } + + message CommentMessage { + optional Message message = 1; + optional MessageKey targetMessageKey = 2; + } + + message ContactMessage { + optional string displayName = 1; + optional string vcard = 16; + optional ContextInfo contextInfo = 17; + } + + message ContactsArrayMessage { + optional string displayName = 1; + repeated Message.ContactMessage contacts = 2; + optional ContextInfo contextInfo = 17; + } + + message DeclinePaymentRequestMessage { + optional MessageKey key = 1; + } + + message DeviceSentMessage { + optional string destinationJid = 1; + optional Message message = 2; + optional string phash = 3; + } + + message DocumentMessage { + optional string url = 1; + optional string mimetype = 2; + optional string title = 3; + optional bytes fileSha256 = 4; + optional uint64 fileLength = 5; + optional uint32 pageCount = 6; + optional bytes mediaKey = 7; + optional string fileName = 8; + optional bytes fileEncSha256 = 9; + optional string directPath = 10; + optional int64 mediaKeyTimestamp = 11; + optional bool contactVcard = 12; + optional string thumbnailDirectPath = 13; + optional bytes thumbnailSha256 = 14; + optional bytes thumbnailEncSha256 = 15; + optional bytes jpegThumbnail = 16; + optional ContextInfo contextInfo = 17; + optional uint32 thumbnailHeight = 18; + optional uint32 thumbnailWidth = 19; + optional string caption = 20; + } + + message EncCommentMessage { + optional MessageKey targetMessageKey = 1; + optional bytes encPayload = 2; + optional bytes encIv = 3; + } + + message EncEventResponseMessage { + optional MessageKey eventCreationMessageKey = 1; + optional bytes encPayload = 2; + optional bytes encIv = 3; + } + + message EncReactionMessage { + optional MessageKey targetMessageKey = 1; + optional bytes encPayload = 2; + optional bytes encIv = 3; + } + + message EventMessage { + optional ContextInfo contextInfo = 1; + optional bool isCanceled = 2; + optional string name = 3; + optional string description = 4; + optional Message.LocationMessage location = 5; + optional string joinLink = 6; + optional int64 startTime = 7; + } + + message EventResponseMessage { + optional EventResponseType response = 1; + optional int64 timestampMs = 2; + enum EventResponseType { + UNKNOWN = 0; + GOING = 1; + NOT_GOING = 2; + } + } + + message ExtendedTextMessage { + optional string text = 1; + optional string matchedText = 2; + optional string canonicalUrl = 4; + optional string description = 5; + optional string title = 6; + optional fixed32 textArgb = 7; + optional fixed32 backgroundArgb = 8; + optional FontType font = 9; + optional PreviewType previewType = 10; + optional bytes jpegThumbnail = 16; + optional ContextInfo contextInfo = 17; + optional bool doNotPlayInline = 18; + optional string thumbnailDirectPath = 19; + optional bytes thumbnailSha256 = 20; + optional bytes thumbnailEncSha256 = 21; + optional bytes mediaKey = 22; + optional int64 mediaKeyTimestamp = 23; + optional uint32 thumbnailHeight = 24; + optional uint32 thumbnailWidth = 25; + optional InviteLinkGroupType inviteLinkGroupType = 26; + optional string inviteLinkParentGroupSubjectV2 = 27; + optional bytes inviteLinkParentGroupThumbnailV2 = 28; + optional InviteLinkGroupType inviteLinkGroupTypeV2 = 29; + optional bool viewOnce = 30; + enum FontType { + SYSTEM = 0; + SYSTEM_TEXT = 1; + FB_SCRIPT = 2; + SYSTEM_BOLD = 6; + MORNINGBREEZE_REGULAR = 7; + CALISTOGA_REGULAR = 8; + EXO2_EXTRABOLD = 9; + COURIERPRIME_BOLD = 10; + } + enum InviteLinkGroupType { + DEFAULT = 0; + PARENT = 1; + SUB = 2; + DEFAULT_SUB = 3; + } + enum PreviewType { + NONE = 0; + VIDEO = 1; + PLACEHOLDER = 4; + IMAGE = 5; + } + } + + message ExtendedTextMessageWithParentKey { + optional MessageKey key = 1; + optional Message.ExtendedTextMessage extendedTextMessage = 2; + } + + message FutureProofMessage { + optional Message message = 1; + } + + message GroupInviteMessage { + optional string groupJid = 1; + optional string inviteCode = 2; + optional int64 inviteExpiration = 3; + optional string groupName = 4; + optional bytes jpegThumbnail = 5; + optional string caption = 6; + optional ContextInfo contextInfo = 7; + optional GroupType groupType = 8; + enum GroupType { + DEFAULT = 0; + PARENT = 1; + } + } + + message HighlyStructuredMessage { + optional string namespace = 1; + optional string elementName = 2; + repeated string params = 3; + optional string fallbackLg = 4; + optional string fallbackLc = 5; + repeated HSMLocalizableParameter localizableParams = 6; + optional string deterministicLg = 7; + optional string deterministicLc = 8; + optional Message.TemplateMessage hydratedHsm = 9; + message HSMLocalizableParameter { + optional string default = 1; + oneof paramOneof { + Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMCurrency currency = 2; + Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMDateTime dateTime = 3; + } + message HSMCurrency { + optional string currencyCode = 1; + optional int64 amount1000 = 2; + } + + message HSMDateTime { + oneof datetimeOneof { + Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMDateTime.HSMDateTimeComponent component = 1; + Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMDateTime.HSMDateTimeUnixEpoch unixEpoch = 2; + } + message HSMDateTimeComponent { + optional DayOfWeekType dayOfWeek = 1; + optional uint32 year = 2; + optional uint32 month = 3; + optional uint32 dayOfMonth = 4; + optional uint32 hour = 5; + optional uint32 minute = 6; + optional CalendarType calendar = 7; + enum CalendarType { + GREGORIAN = 1; + SOLAR_HIJRI = 2; + } + enum DayOfWeekType { + MONDAY = 1; + TUESDAY = 2; + WEDNESDAY = 3; + THURSDAY = 4; + FRIDAY = 5; + SATURDAY = 6; + SUNDAY = 7; + } + } + + message HSMDateTimeUnixEpoch { + optional int64 timestamp = 1; + } + + } + + } + + } + + message HistorySyncNotification { + optional bytes fileSha256 = 1; + optional uint64 fileLength = 2; + optional bytes mediaKey = 3; + optional bytes fileEncSha256 = 4; + optional string directPath = 5; + optional HistorySyncType syncType = 6; + optional uint32 chunkOrder = 7; + optional string originalMessageId = 8; + optional uint32 progress = 9; + optional int64 oldestMsgInChunkTimestampSec = 10; + optional bytes initialHistBootstrapInlinePayload = 11; + optional string peerDataRequestSessionId = 12; + enum HistorySyncType { + INITIAL_BOOTSTRAP = 0; + INITIAL_STATUS_V3 = 1; + FULL = 2; + RECENT = 3; + PUSH_NAME = 4; + NON_BLOCKING_DATA = 5; + ON_DEMAND = 6; + } + } + + message ImageMessage { + optional string url = 1; + optional string mimetype = 2; + optional string caption = 3; + optional bytes fileSha256 = 4; + optional uint64 fileLength = 5; + optional uint32 height = 6; + optional uint32 width = 7; + optional bytes mediaKey = 8; + optional bytes fileEncSha256 = 9; + repeated InteractiveAnnotation interactiveAnnotations = 10; + optional string directPath = 11; + optional int64 mediaKeyTimestamp = 12; + optional bytes jpegThumbnail = 16; + optional ContextInfo contextInfo = 17; + optional bytes firstScanSidecar = 18; + optional uint32 firstScanLength = 19; + optional uint32 experimentGroupId = 20; + optional bytes scansSidecar = 21; + repeated uint32 scanLengths = 22; + optional bytes midQualityFileSha256 = 23; + optional bytes midQualityFileEncSha256 = 24; + optional bool viewOnce = 25; + optional string thumbnailDirectPath = 26; + optional bytes thumbnailSha256 = 27; + optional bytes thumbnailEncSha256 = 28; + optional string staticUrl = 29; + repeated InteractiveAnnotation annotations = 30; + } + + message InitialSecurityNotificationSettingSync { + optional bool securityNotificationEnabled = 1; + } + + message InteractiveMessage { + optional Header header = 1; + optional Body body = 2; + optional Footer footer = 3; + optional ContextInfo contextInfo = 15; + oneof interactiveMessage { + Message.InteractiveMessage.ShopMessage shopStorefrontMessage = 4; + Message.InteractiveMessage.CollectionMessage collectionMessage = 5; + Message.InteractiveMessage.NativeFlowMessage nativeFlowMessage = 6; + Message.InteractiveMessage.CarouselMessage carouselMessage = 7; + } + message Body { + optional string text = 1; + } + + message CarouselMessage { + repeated Message.InteractiveMessage cards = 1; + optional int32 messageVersion = 2; + } + + message CollectionMessage { + optional string bizJid = 1; + optional string id = 2; + optional int32 messageVersion = 3; + } + + message Footer { + optional string text = 1; + } + + message Header { + optional string title = 1; + optional string subtitle = 2; + optional bool hasMediaAttachment = 5; + oneof media { + Message.DocumentMessage documentMessage = 3; + Message.ImageMessage imageMessage = 4; + bytes jpegThumbnail = 6; + Message.VideoMessage videoMessage = 7; + Message.LocationMessage locationMessage = 8; + Message.ProductMessage productMessage = 9; + } + } + + message NativeFlowMessage { + repeated NativeFlowButton buttons = 1; + optional string messageParamsJson = 2; + optional int32 messageVersion = 3; + message NativeFlowButton { + optional string name = 1; + optional string buttonParamsJson = 2; + } + + } + + message ShopMessage { + optional string id = 1; + optional Surface surface = 2; + optional int32 messageVersion = 3; + enum Surface { + UNKNOWN_SURFACE = 0; + FB = 1; + IG = 2; + WA = 3; + } + } + + } + + message InteractiveResponseMessage { + optional Body body = 1; + optional ContextInfo contextInfo = 15; + oneof interactiveResponseMessage { + Message.InteractiveResponseMessage.NativeFlowResponseMessage nativeFlowResponseMessage = 2; + } + message Body { + optional string text = 1; + optional Format format = 2; + enum Format { + DEFAULT = 0; + EXTENSIONS_1 = 1; + } + } + + message NativeFlowResponseMessage { + optional string name = 1; + optional string paramsJson = 2; + optional int32 version = 3; + } + + } + + message InvoiceMessage { + optional string note = 1; + optional string token = 2; + optional AttachmentType attachmentType = 3; + optional string attachmentMimetype = 4; + optional bytes attachmentMediaKey = 5; + optional int64 attachmentMediaKeyTimestamp = 6; + optional bytes attachmentFileSha256 = 7; + optional bytes attachmentFileEncSha256 = 8; + optional string attachmentDirectPath = 9; + optional bytes attachmentJpegThumbnail = 10; + enum AttachmentType { + IMAGE = 0; + PDF = 1; + } + } + + message KeepInChatMessage { + optional MessageKey key = 1; + optional KeepType keepType = 2; + optional int64 timestampMs = 3; + } + + message ListMessage { + optional string title = 1; + optional string description = 2; + optional string buttonText = 3; + optional ListType listType = 4; + repeated Section sections = 5; + optional ProductListInfo productListInfo = 6; + optional string footerText = 7; + optional ContextInfo contextInfo = 8; + enum ListType { + UNKNOWN = 0; + SINGLE_SELECT = 1; + PRODUCT_LIST = 2; + } + message Product { + optional string productId = 1; + } + + message ProductListHeaderImage { + optional string productId = 1; + optional bytes jpegThumbnail = 2; + } + + message ProductListInfo { + repeated Message.ListMessage.ProductSection productSections = 1; + optional Message.ListMessage.ProductListHeaderImage headerImage = 2; + optional string businessOwnerJid = 3; + } + + message ProductSection { + optional string title = 1; + repeated Message.ListMessage.Product products = 2; + } + + message Row { + optional string title = 1; + optional string description = 2; + optional string rowId = 3; + } + + message Section { + optional string title = 1; + repeated Message.ListMessage.Row rows = 2; + } + + } + + message ListResponseMessage { + optional string title = 1; + optional ListType listType = 2; + optional SingleSelectReply singleSelectReply = 3; + optional ContextInfo contextInfo = 4; + optional string description = 5; + enum ListType { + UNKNOWN = 0; + SINGLE_SELECT = 1; + } + message SingleSelectReply { + optional string selectedRowId = 1; + } + + } + + message LiveLocationMessage { + optional double degreesLatitude = 1; + optional double degreesLongitude = 2; + optional uint32 accuracyInMeters = 3; + optional float speedInMps = 4; + optional uint32 degreesClockwiseFromMagneticNorth = 5; + optional string caption = 6; + optional int64 sequenceNumber = 7; + optional uint32 timeOffset = 8; + optional bytes jpegThumbnail = 16; + optional ContextInfo contextInfo = 17; + } + + message LocationMessage { + optional double degreesLatitude = 1; + optional double degreesLongitude = 2; + optional string name = 3; + optional string address = 4; + optional string url = 5; + optional bool isLive = 6; + optional uint32 accuracyInMeters = 7; + optional float speedInMps = 8; + optional uint32 degreesClockwiseFromMagneticNorth = 9; + optional string comment = 11; + optional bytes jpegThumbnail = 16; + optional ContextInfo contextInfo = 17; + } + + message MessageHistoryBundle { + optional string mimetype = 2; + optional bytes fileSha256 = 3; + optional bytes mediaKey = 5; + optional bytes fileEncSha256 = 6; + optional string directPath = 7; + optional int64 mediaKeyTimestamp = 8; + optional ContextInfo contextInfo = 9; + repeated string participants = 10; + } + + message NewsletterAdminInviteMessage { + optional string newsletterJid = 1; + optional string newsletterName = 2; + optional bytes jpegThumbnail = 3; + optional string caption = 4; + optional int64 inviteExpiration = 5; + } + + message OrderMessage { + optional string orderId = 1; + optional bytes thumbnail = 2; + optional int32 itemCount = 3; + optional OrderStatus status = 4; + optional OrderSurface surface = 5; + optional string message = 6; + optional string orderTitle = 7; + optional string sellerJid = 8; + optional string token = 9; + optional int64 totalAmount1000 = 10; + optional string totalCurrencyCode = 11; + optional ContextInfo contextInfo = 17; + optional int32 messageVersion = 12; + optional MessageKey orderRequestMessageId = 13; + enum OrderStatus { + INQUIRY = 1; + ACCEPTED = 2; + DECLINED = 3; + } + enum OrderSurface { + CATALOG = 1; + } + } + + message PaymentInviteMessage { + optional ServiceType serviceType = 1; + optional int64 expiryTimestamp = 2; + enum ServiceType { + UNKNOWN = 0; + FBPAY = 1; + NOVI = 2; + UPI = 3; + } + } + + message PeerDataOperationRequestMessage { + optional Message.PeerDataOperationRequestType peerDataOperationRequestType = 1; + repeated RequestStickerReupload requestStickerReupload = 2; + repeated RequestUrlPreview requestUrlPreview = 3; + optional HistorySyncOnDemandRequest historySyncOnDemandRequest = 4; + repeated PlaceholderMessageResendRequest placeholderMessageResendRequest = 5; + message HistorySyncOnDemandRequest { + optional string chatJid = 1; + optional string oldestMsgId = 2; + optional bool oldestMsgFromMe = 3; + optional int32 onDemandMsgCount = 4; + optional int64 oldestMsgTimestampMs = 5; + } + + message PlaceholderMessageResendRequest { + optional MessageKey messageKey = 1; + } + + message RequestStickerReupload { + optional string fileSha256 = 1; + } + + message RequestUrlPreview { + optional string url = 1; + optional bool includeHqThumbnail = 2; + } + + } + + message PeerDataOperationRequestResponseMessage { + optional Message.PeerDataOperationRequestType peerDataOperationRequestType = 1; + optional string stanzaId = 2; + repeated PeerDataOperationResult peerDataOperationResult = 3; + message PeerDataOperationResult { + optional MediaRetryNotification.ResultType mediaUploadResult = 1; + optional Message.StickerMessage stickerMessage = 2; + optional LinkPreviewResponse linkPreviewResponse = 3; + optional PlaceholderMessageResendResponse placeholderMessageResendResponse = 4; + message LinkPreviewResponse { + optional string url = 1; + optional string title = 2; + optional string description = 3; + optional bytes thumbData = 4; + optional string canonicalUrl = 5; + optional string matchText = 6; + optional string previewType = 7; + optional LinkPreviewHighQualityThumbnail hqThumbnail = 8; + message LinkPreviewHighQualityThumbnail { + optional string directPath = 1; + optional string thumbHash = 2; + optional string encThumbHash = 3; + optional bytes mediaKey = 4; + optional int64 mediaKeyTimestampMs = 5; + optional int32 thumbWidth = 6; + optional int32 thumbHeight = 7; + } + + } + + message PlaceholderMessageResendResponse { + optional bytes webMessageInfoBytes = 1; + } + + } + + } + + enum PeerDataOperationRequestType { + UPLOAD_STICKER = 0; + SEND_RECENT_STICKER_BOOTSTRAP = 1; + GENERATE_LINK_PREVIEW = 2; + HISTORY_SYNC_ON_DEMAND = 3; + PLACEHOLDER_MESSAGE_RESEND = 4; + } + message PinInChatMessage { + optional MessageKey key = 1; + optional Type type = 2; + optional int64 senderTimestampMs = 3; + enum Type { + UNKNOWN_TYPE = 0; + PIN_FOR_ALL = 1; + UNPIN_FOR_ALL = 2; + } + } + + message PlaceholderMessage { + optional PlaceholderType type = 1; + enum PlaceholderType { + MASK_LINKED_DEVICES = 0; + } + } + + message PollCreationMessage { + optional bytes encKey = 1; + optional string name = 2; + repeated Option options = 3; + optional uint32 selectableOptionsCount = 4; + optional ContextInfo contextInfo = 5; + message Option { + optional string optionName = 1; + } + + } + + message PollEncValue { + optional bytes encPayload = 1; + optional bytes encIv = 2; + } + + message PollUpdateMessage { + optional MessageKey pollCreationMessageKey = 1; + optional Message.PollEncValue vote = 2; + optional Message.PollUpdateMessageMetadata metadata = 3; + optional int64 senderTimestampMs = 4; + } + + message PollUpdateMessageMetadata { + } + + message PollVoteMessage { + repeated bytes selectedOptions = 1; + } + + message ProductMessage { + optional ProductSnapshot product = 1; + optional string businessOwnerJid = 2; + optional CatalogSnapshot catalog = 4; + optional string body = 5; + optional string footer = 6; + optional ContextInfo contextInfo = 17; + message CatalogSnapshot { + optional Message.ImageMessage catalogImage = 1; + optional string title = 2; + optional string description = 3; + } + + message ProductSnapshot { + optional Message.ImageMessage productImage = 1; + optional string productId = 2; + optional string title = 3; + optional string description = 4; + optional string currencyCode = 5; + optional int64 priceAmount1000 = 6; + optional string retailerId = 7; + optional string url = 8; + optional uint32 productImageCount = 9; + optional string firstImageId = 11; + optional int64 salePriceAmount1000 = 12; + } + + } + + message ProtocolMessage { + optional MessageKey key = 1; + optional Type type = 2; + optional uint32 ephemeralExpiration = 4; + optional int64 ephemeralSettingTimestamp = 5; + optional Message.HistorySyncNotification historySyncNotification = 6; + optional Message.AppStateSyncKeyShare appStateSyncKeyShare = 7; + optional Message.AppStateSyncKeyRequest appStateSyncKeyRequest = 8; + optional Message.InitialSecurityNotificationSettingSync initialSecurityNotificationSettingSync = 9; + optional Message.AppStateFatalExceptionNotification appStateFatalExceptionNotification = 10; + optional DisappearingMode disappearingMode = 11; + optional Message editedMessage = 14; + optional int64 timestampMs = 15; + optional Message.PeerDataOperationRequestMessage peerDataOperationRequestMessage = 16; + optional Message.PeerDataOperationRequestResponseMessage peerDataOperationRequestResponseMessage = 17; + optional Message.BotFeedbackMessage botFeedbackMessage = 18; + optional string invokerJid = 19; + optional Message.RequestWelcomeMessageMetadata requestWelcomeMessageMetadata = 20; + optional MediaNotifyMessage mediaNotifyMessage = 21; + enum Type { + REVOKE = 0; + EPHEMERAL_SETTING = 3; + EPHEMERAL_SYNC_RESPONSE = 4; + HISTORY_SYNC_NOTIFICATION = 5; + APP_STATE_SYNC_KEY_SHARE = 6; + APP_STATE_SYNC_KEY_REQUEST = 7; + MSG_FANOUT_BACKFILL_REQUEST = 8; + INITIAL_SECURITY_NOTIFICATION_SETTING_SYNC = 9; + APP_STATE_FATAL_EXCEPTION_NOTIFICATION = 10; + SHARE_PHONE_NUMBER = 11; + MESSAGE_EDIT = 14; + PEER_DATA_OPERATION_REQUEST_MESSAGE = 16; + PEER_DATA_OPERATION_REQUEST_RESPONSE_MESSAGE = 17; + REQUEST_WELCOME_MESSAGE = 18; + BOT_FEEDBACK_MESSAGE = 19; + MEDIA_NOTIFY_MESSAGE = 20; + } + } + + message ReactionMessage { + optional MessageKey key = 1; + optional string text = 2; + optional string groupingKey = 3; + optional int64 senderTimestampMs = 4; + } + + message RequestPaymentMessage { + optional Message noteMessage = 4; + optional string currencyCodeIso4217 = 1; + optional uint64 amount1000 = 2; + optional string requestFrom = 3; + optional int64 expiryTimestamp = 5; + optional Money amount = 6; + optional PaymentBackground background = 7; + } + + message RequestPhoneNumberMessage { + optional ContextInfo contextInfo = 1; + } + + message RequestWelcomeMessageMetadata { + optional LocalChatState localChatState = 1; + enum LocalChatState { + EMPTY = 0; + NON_EMPTY = 1; + } + } + + message ScheduledCallCreationMessage { + optional int64 scheduledTimestampMs = 1; + optional CallType callType = 2; + optional string title = 3; + enum CallType { + UNKNOWN = 0; + VOICE = 1; + VIDEO = 2; + } + } + + message ScheduledCallEditMessage { + optional MessageKey key = 1; + optional EditType editType = 2; + enum EditType { + UNKNOWN = 0; + CANCEL = 1; + } + } + + message SecretEncryptedMessage { + optional MessageKey targetMessageKey = 1; + optional bytes encPayload = 2; + optional bytes encIv = 3; + optional SecretEncType secretEncType = 4; + enum SecretEncType { + UNKNOWN = 0; + EVENT_RESPONSE = 1; + EVENT_EDIT = 2; + } + } + + message SendPaymentMessage { + optional Message noteMessage = 2; + optional MessageKey requestMessageKey = 3; + optional PaymentBackground background = 4; + } + + message SenderKeyDistributionMessage { + optional string groupId = 1; + optional bytes axolotlSenderKeyDistributionMessage = 2; + } + + message StickerMessage { + optional string url = 1; + optional bytes fileSha256 = 2; + optional bytes fileEncSha256 = 3; + optional bytes mediaKey = 4; + optional string mimetype = 5; + optional uint32 height = 6; + optional uint32 width = 7; + optional string directPath = 8; + optional uint64 fileLength = 9; + optional int64 mediaKeyTimestamp = 10; + optional uint32 firstFrameLength = 11; + optional bytes firstFrameSidecar = 12; + optional bool isAnimated = 13; + optional bytes pngThumbnail = 16; + optional ContextInfo contextInfo = 17; + optional int64 stickerSentTs = 18; + optional bool isAvatar = 19; + optional bool isAiSticker = 20; + optional bool isLottie = 21; + } + + message StickerSyncRMRMessage { + repeated string filehash = 1; + optional string rmrSource = 2; + optional int64 requestTimestamp = 3; + } + + message TemplateButtonReplyMessage { + optional string selectedId = 1; + optional string selectedDisplayText = 2; + optional ContextInfo contextInfo = 3; + optional uint32 selectedIndex = 4; + optional uint32 selectedCarouselCardIndex = 5; + } + + message TemplateMessage { + optional ContextInfo contextInfo = 3; + optional HydratedFourRowTemplate hydratedTemplate = 4; + optional string templateId = 9; + oneof format { + Message.TemplateMessage.FourRowTemplate fourRowTemplate = 1; + Message.TemplateMessage.HydratedFourRowTemplate hydratedFourRowTemplate = 2; + Message.InteractiveMessage interactiveMessageTemplate = 5; + } + message FourRowTemplate { + optional Message.HighlyStructuredMessage content = 6; + optional Message.HighlyStructuredMessage footer = 7; + repeated TemplateButton buttons = 8; + oneof title { + Message.DocumentMessage documentMessage = 1; + Message.HighlyStructuredMessage highlyStructuredMessage = 2; + Message.ImageMessage imageMessage = 3; + Message.VideoMessage videoMessage = 4; + Message.LocationMessage locationMessage = 5; + } + } + + message HydratedFourRowTemplate { + optional string hydratedContentText = 6; + optional string hydratedFooterText = 7; + repeated HydratedTemplateButton hydratedButtons = 8; + optional string templateId = 9; + optional bool maskLinkedDevices = 10; + oneof title { + Message.DocumentMessage documentMessage = 1; + string hydratedTitleText = 2; + Message.ImageMessage imageMessage = 3; + Message.VideoMessage videoMessage = 4; + Message.LocationMessage locationMessage = 5; + } + } + + } + + message VideoMessage { + optional string url = 1; + optional string mimetype = 2; + optional bytes fileSha256 = 3; + optional uint64 fileLength = 4; + optional uint32 seconds = 5; + optional bytes mediaKey = 6; + optional string caption = 7; + optional bool gifPlayback = 8; + optional uint32 height = 9; + optional uint32 width = 10; + optional bytes fileEncSha256 = 11; + repeated InteractiveAnnotation interactiveAnnotations = 12; + optional string directPath = 13; + optional int64 mediaKeyTimestamp = 14; + optional bytes jpegThumbnail = 16; + optional ContextInfo contextInfo = 17; + optional bytes streamingSidecar = 18; + optional Attribution gifAttribution = 19; + optional bool viewOnce = 20; + optional string thumbnailDirectPath = 21; + optional bytes thumbnailSha256 = 22; + optional bytes thumbnailEncSha256 = 23; + optional string staticUrl = 24; + repeated InteractiveAnnotation annotations = 25; + enum Attribution { + NONE = 0; + GIPHY = 1; + TENOR = 2; + } + } + +} + +message MessageAddOnContextInfo { + optional uint32 messageAddOnDurationInSecs = 1; +} + +message MessageContextInfo { + optional DeviceListMetadata deviceListMetadata = 1; + optional int32 deviceListMetadataVersion = 2; + optional bytes messageSecret = 3; + optional bytes paddingBytes = 4; + optional uint32 messageAddOnDurationInSecs = 5; + optional bytes botMessageSecret = 6; + optional BotMetadata botMetadata = 7; + optional int32 reportingTokenVersion = 8; +} + +message MessageKey { + optional string remoteJid = 1; + optional bool fromMe = 2; + optional string id = 3; + optional string participant = 4; +} + +message MessageSecretMessage { + optional sfixed32 version = 1; + optional bytes encIv = 2; + optional bytes encPayload = 3; +} + +message Money { + optional int64 value = 1; + optional uint32 offset = 2; + optional string currencyCode = 3; +} + +message MsgOpaqueData { + optional string body = 1; + optional string caption = 3; + optional double lng = 5; + optional bool isLive = 6; + optional double lat = 7; + optional int32 paymentAmount1000 = 8; + optional string paymentNoteMsgBody = 9; + optional string canonicalUrl = 10; + optional string matchedText = 11; + optional string title = 12; + optional string description = 13; + optional bytes futureproofBuffer = 14; + optional string clientUrl = 15; + optional string loc = 16; + optional string pollName = 17; + repeated PollOption pollOptions = 18; + optional uint32 pollSelectableOptionsCount = 20; + optional bytes messageSecret = 21; + optional string originalSelfAuthor = 51; + optional int64 senderTimestampMs = 22; + optional string pollUpdateParentKey = 23; + optional PollEncValue encPollVote = 24; + optional bool isSentCagPollCreation = 28; + optional string encReactionTargetMessageKey = 25; + optional bytes encReactionEncPayload = 26; + optional bytes encReactionEncIv = 27; + optional bytes botMessageSecret = 29; + optional string targetMessageKey = 30; + optional bytes encPayload = 31; + optional bytes encIv = 32; + message PollOption { + optional string name = 1; + } + +} + +message MsgRowOpaqueData { + optional MsgOpaqueData currentMsg = 1; + optional MsgOpaqueData quotedMsg = 2; +} + +message NoiseCertificate { + optional bytes details = 1; + optional bytes signature = 2; + message Details { + optional uint32 serial = 1; + optional string issuer = 2; + optional uint64 expires = 3; + optional string subject = 4; + optional bytes key = 5; + } + +} + +message NotificationMessageInfo { + optional MessageKey key = 1; + optional Message message = 2; + optional uint64 messageTimestamp = 3; + optional string participant = 4; +} + +message NotificationSettings { + optional string messageVibrate = 1; + optional string messagePopup = 2; + optional string messageLight = 3; + optional bool lowPriorityNotifications = 4; + optional bool reactionsMuted = 5; + optional string callVibrate = 6; +} + +message PastParticipant { + optional string userJid = 1; + optional LeaveReason leaveReason = 2; + optional uint64 leaveTs = 3; + enum LeaveReason { + LEFT = 0; + REMOVED = 1; + } +} + +message PastParticipants { + optional string groupJid = 1; + repeated PastParticipant pastParticipants = 2; +} + +message PatchDebugData { + optional bytes currentLthash = 1; + optional bytes newLthash = 2; + optional bytes patchVersion = 3; + optional bytes collectionName = 4; + optional bytes firstFourBytesFromAHashOfSnapshotMacKey = 5; + optional bytes newLthashSubtract = 6; + optional int32 numberAdd = 7; + optional int32 numberRemove = 8; + optional int32 numberOverride = 9; + optional Platform senderPlatform = 10; + optional bool isSenderPrimary = 11; + enum Platform { + ANDROID = 0; + SMBA = 1; + IPHONE = 2; + SMBI = 3; + WEB = 4; + UWP = 5; + DARWIN = 6; + } +} + +message PaymentBackground { + optional string id = 1; + optional uint64 fileLength = 2; + optional uint32 width = 3; + optional uint32 height = 4; + optional string mimetype = 5; + optional fixed32 placeholderArgb = 6; + optional fixed32 textArgb = 7; + optional fixed32 subtextArgb = 8; + optional MediaData mediaData = 9; + optional Type type = 10; + message MediaData { + optional bytes mediaKey = 1; + optional int64 mediaKeyTimestamp = 2; + optional bytes fileSha256 = 3; + optional bytes fileEncSha256 = 4; + optional string directPath = 5; + } + + enum Type { + UNKNOWN = 0; + DEFAULT = 1; + } +} + +message PaymentInfo { + optional Currency currencyDeprecated = 1; + optional uint64 amount1000 = 2; + optional string receiverJid = 3; + optional Status status = 4; + optional uint64 transactionTimestamp = 5; + optional MessageKey requestMessageKey = 6; + optional uint64 expiryTimestamp = 7; + optional bool futureproofed = 8; + optional string currency = 9; + optional TxnStatus txnStatus = 10; + optional bool useNoviFiatFormat = 11; + optional Money primaryAmount = 12; + optional Money exchangeAmount = 13; + enum Currency { + UNKNOWN_CURRENCY = 0; + INR = 1; + } + enum Status { + UNKNOWN_STATUS = 0; + PROCESSING = 1; + SENT = 2; + NEED_TO_ACCEPT = 3; + COMPLETE = 4; + COULD_NOT_COMPLETE = 5; + REFUNDED = 6; + EXPIRED = 7; + REJECTED = 8; + CANCELLED = 9; + WAITING_FOR_PAYER = 10; + WAITING = 11; + } + enum TxnStatus { + UNKNOWN = 0; + PENDING_SETUP = 1; + PENDING_RECEIVER_SETUP = 2; + INIT = 3; + SUCCESS = 4; + COMPLETED = 5; + FAILED = 6; + FAILED_RISK = 7; + FAILED_PROCESSING = 8; + FAILED_RECEIVER_PROCESSING = 9; + FAILED_DA = 10; + FAILED_DA_FINAL = 11; + REFUNDED_TXN = 12; + REFUND_FAILED = 13; + REFUND_FAILED_PROCESSING = 14; + REFUND_FAILED_DA = 15; + EXPIRED_TXN = 16; + AUTH_CANCELED = 17; + AUTH_CANCEL_FAILED_PROCESSING = 18; + AUTH_CANCEL_FAILED = 19; + COLLECT_INIT = 20; + COLLECT_SUCCESS = 21; + COLLECT_FAILED = 22; + COLLECT_FAILED_RISK = 23; + COLLECT_REJECTED = 24; + COLLECT_EXPIRED = 25; + COLLECT_CANCELED = 26; + COLLECT_CANCELLING = 27; + IN_REVIEW = 28; + REVERSAL_SUCCESS = 29; + REVERSAL_PENDING = 30; + REFUND_PENDING = 31; + } +} + +message PhoneNumberToLIDMapping { + optional string pnJid = 1; + optional string lidJid = 2; +} + +message PhotoChange { + optional bytes oldPhoto = 1; + optional bytes newPhoto = 2; + optional uint32 newPhotoId = 3; +} + +message PinInChat { + optional Type type = 1; + optional MessageKey key = 2; + optional int64 senderTimestampMs = 3; + optional int64 serverTimestampMs = 4; + optional MessageAddOnContextInfo messageAddOnContextInfo = 5; + enum Type { + UNKNOWN_TYPE = 0; + PIN_FOR_ALL = 1; + UNPIN_FOR_ALL = 2; + } +} + +message Point { + optional int32 xDeprecated = 1; + optional int32 yDeprecated = 2; + optional double x = 3; + optional double y = 4; +} + +message PollAdditionalMetadata { + optional bool pollInvalidated = 1; +} + +message PollEncValue { + optional bytes encPayload = 1; + optional bytes encIv = 2; +} + +message PollUpdate { + optional MessageKey pollUpdateMessageKey = 1; + optional Message.PollVoteMessage vote = 2; + optional int64 senderTimestampMs = 3; + optional int64 serverTimestampMs = 4; + optional bool unread = 5; +} + +message PreKeyRecordStructure { + optional uint32 id = 1; + optional bytes publicKey = 2; + optional bytes privateKey = 3; +} + +message PreKeySignalMessage { + optional uint32 registrationId = 5; + optional uint32 preKeyId = 1; + optional uint32 signedPreKeyId = 6; + optional bytes baseKey = 2; + optional bytes identityKey = 3; + optional bytes message = 4; +} + +message PremiumMessageInfo { + optional string serverCampaignId = 1; +} + +message Pushname { + optional string id = 1; + optional string pushname = 2; +} + +message QP { + enum ClauseType { + AND = 1; + OR = 2; + NOR = 3; + } + message Filter { + required string filterName = 1; + repeated QP.FilterParameters parameters = 2; + optional QP.FilterResult filterResult = 3; + required QP.FilterClientNotSupportedConfig clientNotSupportedConfig = 4; + } + + message FilterClause { + required QP.ClauseType clauseType = 1; + repeated QP.FilterClause clauses = 2; + repeated QP.Filter filters = 3; + } + + enum FilterClientNotSupportedConfig { + PASS_BY_DEFAULT = 1; + FAIL_BY_DEFAULT = 2; + } + message FilterParameters { + optional string key = 1; + optional string value = 2; + } + + enum FilterResult { + TRUE = 1; + FALSE = 2; + UNKNOWN = 3; + } +} + +message Reaction { + optional MessageKey key = 1; + optional string text = 2; + optional string groupingKey = 3; + optional int64 senderTimestampMs = 4; + optional bool unread = 5; +} + +message RecentEmojiWeight { + optional string emoji = 1; + optional float weight = 2; +} + +message RecordStructure { + optional SessionStructure currentSession = 1; + repeated SessionStructure previousSessions = 2; +} + +message ReportingTokenInfo { + optional bytes reportingTag = 1; +} + +message SenderKeyDistributionMessage { + optional uint32 id = 1; + optional uint32 iteration = 2; + optional bytes chainKey = 3; + optional bytes signingKey = 4; +} + +message SenderKeyMessage { + optional uint32 id = 1; + optional uint32 iteration = 2; + optional bytes ciphertext = 3; +} + +message SenderKeyRecordStructure { + repeated SenderKeyStateStructure senderKeyStates = 1; +} + +message SenderKeyStateStructure { + optional uint32 senderKeyId = 1; + optional SenderChainKey senderChainKey = 2; + optional SenderSigningKey senderSigningKey = 3; + repeated SenderMessageKey senderMessageKeys = 4; + message SenderChainKey { + optional uint32 iteration = 1; + optional bytes seed = 2; + } + + message SenderMessageKey { + optional uint32 iteration = 1; + optional bytes seed = 2; + } + + message SenderSigningKey { + optional bytes public = 1; + optional bytes private = 2; + } + +} + +message ServerErrorReceipt { + optional string stanzaId = 1; +} + +message SessionStructure { + optional uint32 sessionVersion = 1; + optional bytes localIdentityPublic = 2; + optional bytes remoteIdentityPublic = 3; + optional bytes rootKey = 4; + optional uint32 previousCounter = 5; + optional Chain senderChain = 6; + repeated Chain receiverChains = 7; + optional PendingKeyExchange pendingKeyExchange = 8; + optional PendingPreKey pendingPreKey = 9; + optional uint32 remoteRegistrationId = 10; + optional uint32 localRegistrationId = 11; + optional bool needsRefresh = 12; + optional bytes aliceBaseKey = 13; + message Chain { + optional bytes senderRatchetKey = 1; + optional bytes senderRatchetKeyPrivate = 2; + optional ChainKey chainKey = 3; + repeated MessageKey messageKeys = 4; + message ChainKey { + optional uint32 index = 1; + optional bytes key = 2; + } + + message MessageKey { + optional uint32 index = 1; + optional bytes cipherKey = 2; + optional bytes macKey = 3; + optional bytes iv = 4; + } + + } + + message PendingKeyExchange { + optional uint32 sequence = 1; + optional bytes localBaseKey = 2; + optional bytes localBaseKeyPrivate = 3; + optional bytes localRatchetKey = 4; + optional bytes localRatchetKeyPrivate = 5; + optional bytes localIdentityKey = 7; + optional bytes localIdentityKeyPrivate = 8; + } + + message PendingPreKey { + optional uint32 preKeyId = 1; + optional int32 signedPreKeyId = 3; + optional bytes baseKey = 2; + } + +} + +message SignalMessage { + optional bytes ratchetKey = 1; + optional uint32 counter = 2; + optional uint32 previousCounter = 3; + optional bytes ciphertext = 4; +} + +message SignedPreKeyRecordStructure { + optional uint32 id = 1; + optional bytes publicKey = 2; + optional bytes privateKey = 3; + optional bytes signature = 4; + optional fixed64 timestamp = 5; +} + +message StatusPSA { + required uint64 campaignId = 44; + optional uint64 campaignExpirationTimestamp = 45; +} + +message StickerMetadata { + optional string url = 1; + optional bytes fileSha256 = 2; + optional bytes fileEncSha256 = 3; + optional bytes mediaKey = 4; + optional string mimetype = 5; + optional uint32 height = 6; + optional uint32 width = 7; + optional string directPath = 8; + optional uint64 fileLength = 9; + optional float weight = 10; + optional int64 lastStickerSentTs = 11; +} + +message SyncActionData { + optional bytes index = 1; + optional SyncActionValue value = 2; + optional bytes padding = 3; + optional int32 version = 4; +} + +message SyncActionValue { + optional int64 timestamp = 1; + optional StarAction starAction = 2; + optional ContactAction contactAction = 3; + optional MuteAction muteAction = 4; + optional PinAction pinAction = 5; + optional SecurityNotificationSetting securityNotificationSetting = 6; + optional PushNameSetting pushNameSetting = 7; + optional QuickReplyAction quickReplyAction = 8; + optional RecentEmojiWeightsAction recentEmojiWeightsAction = 11; + optional LabelEditAction labelEditAction = 14; + optional LabelAssociationAction labelAssociationAction = 15; + optional LocaleSetting localeSetting = 16; + optional ArchiveChatAction archiveChatAction = 17; + optional DeleteMessageForMeAction deleteMessageForMeAction = 18; + optional KeyExpiration keyExpiration = 19; + optional MarkChatAsReadAction markChatAsReadAction = 20; + optional ClearChatAction clearChatAction = 21; + optional DeleteChatAction deleteChatAction = 22; + optional UnarchiveChatsSetting unarchiveChatsSetting = 23; + optional PrimaryFeature primaryFeature = 24; + optional AndroidUnsupportedActions androidUnsupportedActions = 26; + optional AgentAction agentAction = 27; + optional SubscriptionAction subscriptionAction = 28; + optional UserStatusMuteAction userStatusMuteAction = 29; + optional TimeFormatAction timeFormatAction = 30; + optional NuxAction nuxAction = 31; + optional PrimaryVersionAction primaryVersionAction = 32; + optional StickerAction stickerAction = 33; + optional RemoveRecentStickerAction removeRecentStickerAction = 34; + optional ChatAssignmentAction chatAssignment = 35; + optional ChatAssignmentOpenedStatusAction chatAssignmentOpenedStatus = 36; + optional PnForLidChatAction pnForLidChatAction = 37; + optional MarketingMessageAction marketingMessageAction = 38; + optional MarketingMessageBroadcastAction marketingMessageBroadcastAction = 39; + optional ExternalWebBetaAction externalWebBetaAction = 40; + optional PrivacySettingRelayAllCalls privacySettingRelayAllCalls = 41; + optional CallLogAction callLogAction = 42; + optional StatusPrivacyAction statusPrivacy = 44; + optional BotWelcomeRequestAction botWelcomeRequestAction = 45; + optional DeleteIndividualCallLogAction deleteIndividualCallLog = 46; + optional LabelReorderingAction labelReorderingAction = 47; + optional PaymentInfoAction paymentInfoAction = 48; + optional CustomPaymentMethodsAction customPaymentMethodsAction = 49; + message AgentAction { + optional string name = 1; + optional int32 deviceID = 2; + optional bool isDeleted = 3; + } + + message AndroidUnsupportedActions { + optional bool allowed = 1; + } + + message ArchiveChatAction { + optional bool archived = 1; + optional SyncActionValue.SyncActionMessageRange messageRange = 2; + } + + message BotWelcomeRequestAction { + optional bool isSent = 1; + } + + message CallLogAction { + optional CallLogRecord callLogRecord = 1; + } + + message ChatAssignmentAction { + optional string deviceAgentID = 1; + } + + message ChatAssignmentOpenedStatusAction { + optional bool chatOpened = 1; + } + + message ClearChatAction { + optional SyncActionValue.SyncActionMessageRange messageRange = 1; + } + + message ContactAction { + optional string fullName = 1; + optional string firstName = 2; + optional string lidJid = 3; + optional bool saveOnPrimaryAddressbook = 4; + } + + message CustomPaymentMethod { + required string credentialId = 1; + required string country = 2; + required string type = 3; + repeated SyncActionValue.CustomPaymentMethodMetadata metadata = 4; + } + + message CustomPaymentMethodMetadata { + required string key = 1; + required string value = 2; + } + + message CustomPaymentMethodsAction { + repeated SyncActionValue.CustomPaymentMethod customPaymentMethods = 1; + } + + message DeleteChatAction { + optional SyncActionValue.SyncActionMessageRange messageRange = 1; + } + + message DeleteIndividualCallLogAction { + optional string peerJid = 1; + optional bool isIncoming = 2; + } + + message DeleteMessageForMeAction { + optional bool deleteMedia = 1; + optional int64 messageTimestamp = 2; + } + + message ExternalWebBetaAction { + optional bool isOptIn = 1; + } + + message KeyExpiration { + optional int32 expiredKeyEpoch = 1; + } + + message LabelAssociationAction { + optional bool labeled = 1; + } + + message LabelEditAction { + optional string name = 1; + optional int32 color = 2; + optional int32 predefinedId = 3; + optional bool deleted = 4; + optional int32 orderIndex = 5; + } + + message LabelReorderingAction { + repeated int32 sortedLabelIds = 1; + } + + message LocaleSetting { + optional string locale = 1; + } + + message MarkChatAsReadAction { + optional bool read = 1; + optional SyncActionValue.SyncActionMessageRange messageRange = 2; + } + + message MarketingMessageAction { + optional string name = 1; + optional string message = 2; + optional MarketingMessagePrototypeType type = 3; + optional int64 createdAt = 4; + optional int64 lastSentAt = 5; + optional bool isDeleted = 6; + optional string mediaId = 7; + enum MarketingMessagePrototypeType { + PERSONALIZED = 0; + } + } + + message MarketingMessageBroadcastAction { + optional int32 repliedCount = 1; + } + + message MuteAction { + optional bool muted = 1; + optional int64 muteEndTimestamp = 2; + optional bool autoMuted = 3; + } + + message NuxAction { + optional bool acknowledged = 1; + } + + message PaymentInfoAction { + optional string cpi = 1; + } + + message PinAction { + optional bool pinned = 1; + } + + message PnForLidChatAction { + optional string pnJid = 1; + } + + message PrimaryFeature { + repeated string flags = 1; + } + + message PrimaryVersionAction { + optional string version = 1; + } + + message PrivacySettingRelayAllCalls { + optional bool isEnabled = 1; + } + + message PushNameSetting { + optional string name = 1; + } + + message QuickReplyAction { + optional string shortcut = 1; + optional string message = 2; + repeated string keywords = 3; + optional int32 count = 4; + optional bool deleted = 5; + } + + message RecentEmojiWeightsAction { + repeated RecentEmojiWeight weights = 1; + } + + message RemoveRecentStickerAction { + optional int64 lastStickerSentTs = 1; + } + + message SecurityNotificationSetting { + optional bool showNotification = 1; + } + + message StarAction { + optional bool starred = 1; + } + + message StatusPrivacyAction { + optional StatusDistributionMode mode = 1; + repeated string userJid = 2; + enum StatusDistributionMode { + ALLOW_LIST = 0; + DENY_LIST = 1; + CONTACTS = 2; + } + } + + message StickerAction { + optional string url = 1; + optional bytes fileEncSha256 = 2; + optional bytes mediaKey = 3; + optional string mimetype = 4; + optional uint32 height = 5; + optional uint32 width = 6; + optional string directPath = 7; + optional uint64 fileLength = 8; + optional bool isFavorite = 9; + optional uint32 deviceIdHint = 10; + } + + message SubscriptionAction { + optional bool isDeactivated = 1; + optional bool isAutoRenewing = 2; + optional int64 expirationDate = 3; + } + + message SyncActionMessage { + optional MessageKey key = 1; + optional int64 timestamp = 2; + } + + message SyncActionMessageRange { + optional int64 lastMessageTimestamp = 1; + optional int64 lastSystemMessageTimestamp = 2; + repeated SyncActionValue.SyncActionMessage messages = 3; + } + + message TimeFormatAction { + optional bool isTwentyFourHourFormatEnabled = 1; + } + + message UnarchiveChatsSetting { + optional bool unarchiveChats = 1; + } + + message UserStatusMuteAction { + optional bool muted = 1; + } + +} + +message SyncdIndex { + optional bytes blob = 1; +} + +message SyncdMutation { + optional SyncdOperation operation = 1; + optional SyncdRecord record = 2; + enum SyncdOperation { + SET = 0; + REMOVE = 1; + } +} + +message SyncdMutations { + repeated SyncdMutation mutations = 1; +} + +message SyncdPatch { + optional SyncdVersion version = 1; + repeated SyncdMutation mutations = 2; + optional ExternalBlobReference externalMutations = 3; + optional bytes snapshotMac = 4; + optional bytes patchMac = 5; + optional KeyId keyId = 6; + optional ExitCode exitCode = 7; + optional uint32 deviceIndex = 8; + optional bytes clientDebugData = 9; +} + +message SyncdRecord { + optional SyncdIndex index = 1; + optional SyncdValue value = 2; + optional KeyId keyId = 3; +} + +message SyncdSnapshot { + optional SyncdVersion version = 1; + repeated SyncdRecord records = 2; + optional bytes mac = 3; + optional KeyId keyId = 4; +} + +message SyncdValue { + optional bytes blob = 1; +} + +message SyncdVersion { + optional uint64 version = 1; +} + +message TemplateButton { + optional uint32 index = 4; + oneof button { + TemplateButton.QuickReplyButton quickReplyButton = 1; + TemplateButton.URLButton urlButton = 2; + TemplateButton.CallButton callButton = 3; + } + message CallButton { + optional Message.HighlyStructuredMessage displayText = 1; + optional Message.HighlyStructuredMessage phoneNumber = 2; + } + + message QuickReplyButton { + optional Message.HighlyStructuredMessage displayText = 1; + optional string id = 2; + } + + message URLButton { + optional Message.HighlyStructuredMessage displayText = 1; + optional Message.HighlyStructuredMessage url = 2; + } + +} + +message UserReceipt { + required string userJid = 1; + optional int64 receiptTimestamp = 2; + optional int64 readTimestamp = 3; + optional int64 playedTimestamp = 4; + repeated string pendingDeviceJid = 5; + repeated string deliveredDeviceJid = 6; +} + +message VerifiedNameCertificate { + optional bytes details = 1; + optional bytes signature = 2; + optional bytes serverSignature = 3; + message Details { + optional uint64 serial = 1; + optional string issuer = 2; + optional string verifiedName = 4; + repeated LocalizedName localizedNames = 8; + optional uint64 issueTime = 10; + } + +} + +message WallpaperSettings { + optional string filename = 1; + optional uint32 opacity = 2; +} + +message WebFeatures { + optional Flag labelsDisplay = 1; + optional Flag voipIndividualOutgoing = 2; + optional Flag groupsV3 = 3; + optional Flag groupsV3Create = 4; + optional Flag changeNumberV2 = 5; + optional Flag queryStatusV3Thumbnail = 6; + optional Flag liveLocations = 7; + optional Flag queryVname = 8; + optional Flag voipIndividualIncoming = 9; + optional Flag quickRepliesQuery = 10; + optional Flag payments = 11; + optional Flag stickerPackQuery = 12; + optional Flag liveLocationsFinal = 13; + optional Flag labelsEdit = 14; + optional Flag mediaUpload = 15; + optional Flag mediaUploadRichQuickReplies = 18; + optional Flag vnameV2 = 19; + optional Flag videoPlaybackUrl = 20; + optional Flag statusRanking = 21; + optional Flag voipIndividualVideo = 22; + optional Flag thirdPartyStickers = 23; + optional Flag frequentlyForwardedSetting = 24; + optional Flag groupsV4JoinPermission = 25; + optional Flag recentStickers = 26; + optional Flag catalog = 27; + optional Flag starredStickers = 28; + optional Flag voipGroupCall = 29; + optional Flag templateMessage = 30; + optional Flag templateMessageInteractivity = 31; + optional Flag ephemeralMessages = 32; + optional Flag e2ENotificationSync = 33; + optional Flag recentStickersV2 = 34; + optional Flag recentStickersV3 = 36; + optional Flag userNotice = 37; + optional Flag support = 39; + optional Flag groupUiiCleanup = 40; + optional Flag groupDogfoodingInternalOnly = 41; + optional Flag settingsSync = 42; + optional Flag archiveV2 = 43; + optional Flag ephemeralAllowGroupMembers = 44; + optional Flag ephemeral24HDuration = 45; + optional Flag mdForceUpgrade = 46; + optional Flag disappearingMode = 47; + optional Flag externalMdOptInAvailable = 48; + optional Flag noDeleteMessageTimeLimit = 49; + enum Flag { + NOT_STARTED = 0; + FORCE_UPGRADE = 1; + DEVELOPMENT = 2; + PRODUCTION = 3; + } +} + +message WebMessageInfo { + required MessageKey key = 1; + optional Message message = 2; + optional uint64 messageTimestamp = 3; + optional Status status = 4; + optional string participant = 5; + optional uint64 messageC2STimestamp = 6; + optional bool ignore = 16; + optional bool starred = 17; + optional bool broadcast = 18; + optional string pushName = 19; + optional bytes mediaCiphertextSha256 = 20; + optional bool multicast = 21; + optional bool urlText = 22; + optional bool urlNumber = 23; + optional StubType messageStubType = 24; + optional bool clearMedia = 25; + repeated string messageStubParameters = 26; + optional uint32 duration = 27; + repeated string labels = 28; + optional PaymentInfo paymentInfo = 29; + optional Message.LiveLocationMessage finalLiveLocation = 30; + optional PaymentInfo quotedPaymentInfo = 31; + optional uint64 ephemeralStartTimestamp = 32; + optional uint32 ephemeralDuration = 33; + optional bool ephemeralOffToOn = 34; + optional bool ephemeralOutOfSync = 35; + optional BizPrivacyStatus bizPrivacyStatus = 36; + optional string verifiedBizName = 37; + optional MediaData mediaData = 38; + optional PhotoChange photoChange = 39; + repeated UserReceipt userReceipt = 40; + repeated Reaction reactions = 41; + optional MediaData quotedStickerData = 42; + optional bytes futureproofData = 43; + optional StatusPSA statusPsa = 44; + repeated PollUpdate pollUpdates = 45; + optional PollAdditionalMetadata pollAdditionalMetadata = 46; + optional string agentId = 47; + optional bool statusAlreadyViewed = 48; + optional bytes messageSecret = 49; + optional KeepInChat keepInChat = 50; + optional string originalSelfAuthorUserJidString = 51; + optional uint64 revokeMessageTimestamp = 52; + optional PinInChat pinInChat = 54; + optional PremiumMessageInfo premiumMessageInfo = 55; + optional bool is1PBizBotMessage = 56; + optional bool isGroupHistoryMessage = 57; + optional string botMessageInvokerJid = 58; + optional CommentMetadata commentMetadata = 59; + repeated EventResponse eventResponses = 61; + optional ReportingTokenInfo reportingTokenInfo = 62; + optional uint64 newsletterServerId = 63; + enum BizPrivacyStatus { + E2EE = 0; + FB = 2; + BSP = 1; + BSP_AND_FB = 3; + } + enum Status { + ERROR = 0; + PENDING = 1; + SERVER_ACK = 2; + DELIVERY_ACK = 3; + READ = 4; + PLAYED = 5; + } + enum StubType { + UNKNOWN = 0; + REVOKE = 1; + CIPHERTEXT = 2; + FUTUREPROOF = 3; + NON_VERIFIED_TRANSITION = 4; + UNVERIFIED_TRANSITION = 5; + VERIFIED_TRANSITION = 6; + VERIFIED_LOW_UNKNOWN = 7; + VERIFIED_HIGH = 8; + VERIFIED_INITIAL_UNKNOWN = 9; + VERIFIED_INITIAL_LOW = 10; + VERIFIED_INITIAL_HIGH = 11; + VERIFIED_TRANSITION_ANY_TO_NONE = 12; + VERIFIED_TRANSITION_ANY_TO_HIGH = 13; + VERIFIED_TRANSITION_HIGH_TO_LOW = 14; + VERIFIED_TRANSITION_HIGH_TO_UNKNOWN = 15; + VERIFIED_TRANSITION_UNKNOWN_TO_LOW = 16; + VERIFIED_TRANSITION_LOW_TO_UNKNOWN = 17; + VERIFIED_TRANSITION_NONE_TO_LOW = 18; + VERIFIED_TRANSITION_NONE_TO_UNKNOWN = 19; + GROUP_CREATE = 20; + GROUP_CHANGE_SUBJECT = 21; + GROUP_CHANGE_ICON = 22; + GROUP_CHANGE_INVITE_LINK = 23; + GROUP_CHANGE_DESCRIPTION = 24; + GROUP_CHANGE_RESTRICT = 25; + GROUP_CHANGE_ANNOUNCE = 26; + GROUP_PARTICIPANT_ADD = 27; + GROUP_PARTICIPANT_REMOVE = 28; + GROUP_PARTICIPANT_PROMOTE = 29; + GROUP_PARTICIPANT_DEMOTE = 30; + GROUP_PARTICIPANT_INVITE = 31; + GROUP_PARTICIPANT_LEAVE = 32; + GROUP_PARTICIPANT_CHANGE_NUMBER = 33; + BROADCAST_CREATE = 34; + BROADCAST_ADD = 35; + BROADCAST_REMOVE = 36; + GENERIC_NOTIFICATION = 37; + E2E_IDENTITY_CHANGED = 38; + E2E_ENCRYPTED = 39; + CALL_MISSED_VOICE = 40; + CALL_MISSED_VIDEO = 41; + INDIVIDUAL_CHANGE_NUMBER = 42; + GROUP_DELETE = 43; + GROUP_ANNOUNCE_MODE_MESSAGE_BOUNCE = 44; + CALL_MISSED_GROUP_VOICE = 45; + CALL_MISSED_GROUP_VIDEO = 46; + PAYMENT_CIPHERTEXT = 47; + PAYMENT_FUTUREPROOF = 48; + PAYMENT_TRANSACTION_STATUS_UPDATE_FAILED = 49; + PAYMENT_TRANSACTION_STATUS_UPDATE_REFUNDED = 50; + PAYMENT_TRANSACTION_STATUS_UPDATE_REFUND_FAILED = 51; + PAYMENT_TRANSACTION_STATUS_RECEIVER_PENDING_SETUP = 52; + PAYMENT_TRANSACTION_STATUS_RECEIVER_SUCCESS_AFTER_HICCUP = 53; + PAYMENT_ACTION_ACCOUNT_SETUP_REMINDER = 54; + PAYMENT_ACTION_SEND_PAYMENT_REMINDER = 55; + PAYMENT_ACTION_SEND_PAYMENT_INVITATION = 56; + PAYMENT_ACTION_REQUEST_DECLINED = 57; + PAYMENT_ACTION_REQUEST_EXPIRED = 58; + PAYMENT_ACTION_REQUEST_CANCELLED = 59; + BIZ_VERIFIED_TRANSITION_TOP_TO_BOTTOM = 60; + BIZ_VERIFIED_TRANSITION_BOTTOM_TO_TOP = 61; + BIZ_INTRO_TOP = 62; + BIZ_INTRO_BOTTOM = 63; + BIZ_NAME_CHANGE = 64; + BIZ_MOVE_TO_CONSUMER_APP = 65; + BIZ_TWO_TIER_MIGRATION_TOP = 66; + BIZ_TWO_TIER_MIGRATION_BOTTOM = 67; + OVERSIZED = 68; + GROUP_CHANGE_NO_FREQUENTLY_FORWARDED = 69; + GROUP_V4_ADD_INVITE_SENT = 70; + GROUP_PARTICIPANT_ADD_REQUEST_JOIN = 71; + CHANGE_EPHEMERAL_SETTING = 72; + E2E_DEVICE_CHANGED = 73; + VIEWED_ONCE = 74; + E2E_ENCRYPTED_NOW = 75; + BLUE_MSG_BSP_FB_TO_BSP_PREMISE = 76; + BLUE_MSG_BSP_FB_TO_SELF_FB = 77; + BLUE_MSG_BSP_FB_TO_SELF_PREMISE = 78; + BLUE_MSG_BSP_FB_UNVERIFIED = 79; + BLUE_MSG_BSP_FB_UNVERIFIED_TO_SELF_PREMISE_VERIFIED = 80; + BLUE_MSG_BSP_FB_VERIFIED = 81; + BLUE_MSG_BSP_FB_VERIFIED_TO_SELF_PREMISE_UNVERIFIED = 82; + BLUE_MSG_BSP_PREMISE_TO_SELF_PREMISE = 83; + BLUE_MSG_BSP_PREMISE_UNVERIFIED = 84; + BLUE_MSG_BSP_PREMISE_UNVERIFIED_TO_SELF_PREMISE_VERIFIED = 85; + BLUE_MSG_BSP_PREMISE_VERIFIED = 86; + BLUE_MSG_BSP_PREMISE_VERIFIED_TO_SELF_PREMISE_UNVERIFIED = 87; + BLUE_MSG_CONSUMER_TO_BSP_FB_UNVERIFIED = 88; + BLUE_MSG_CONSUMER_TO_BSP_PREMISE_UNVERIFIED = 89; + BLUE_MSG_CONSUMER_TO_SELF_FB_UNVERIFIED = 90; + BLUE_MSG_CONSUMER_TO_SELF_PREMISE_UNVERIFIED = 91; + BLUE_MSG_SELF_FB_TO_BSP_PREMISE = 92; + BLUE_MSG_SELF_FB_TO_SELF_PREMISE = 93; + BLUE_MSG_SELF_FB_UNVERIFIED = 94; + BLUE_MSG_SELF_FB_UNVERIFIED_TO_SELF_PREMISE_VERIFIED = 95; + BLUE_MSG_SELF_FB_VERIFIED = 96; + BLUE_MSG_SELF_FB_VERIFIED_TO_SELF_PREMISE_UNVERIFIED = 97; + BLUE_MSG_SELF_PREMISE_TO_BSP_PREMISE = 98; + BLUE_MSG_SELF_PREMISE_UNVERIFIED = 99; + BLUE_MSG_SELF_PREMISE_VERIFIED = 100; + BLUE_MSG_TO_BSP_FB = 101; + BLUE_MSG_TO_CONSUMER = 102; + BLUE_MSG_TO_SELF_FB = 103; + BLUE_MSG_UNVERIFIED_TO_BSP_FB_VERIFIED = 104; + BLUE_MSG_UNVERIFIED_TO_BSP_PREMISE_VERIFIED = 105; + BLUE_MSG_UNVERIFIED_TO_SELF_FB_VERIFIED = 106; + BLUE_MSG_UNVERIFIED_TO_VERIFIED = 107; + BLUE_MSG_VERIFIED_TO_BSP_FB_UNVERIFIED = 108; + BLUE_MSG_VERIFIED_TO_BSP_PREMISE_UNVERIFIED = 109; + BLUE_MSG_VERIFIED_TO_SELF_FB_UNVERIFIED = 110; + BLUE_MSG_VERIFIED_TO_UNVERIFIED = 111; + BLUE_MSG_BSP_FB_UNVERIFIED_TO_BSP_PREMISE_VERIFIED = 112; + BLUE_MSG_BSP_FB_UNVERIFIED_TO_SELF_FB_VERIFIED = 113; + BLUE_MSG_BSP_FB_VERIFIED_TO_BSP_PREMISE_UNVERIFIED = 114; + BLUE_MSG_BSP_FB_VERIFIED_TO_SELF_FB_UNVERIFIED = 115; + BLUE_MSG_SELF_FB_UNVERIFIED_TO_BSP_PREMISE_VERIFIED = 116; + BLUE_MSG_SELF_FB_VERIFIED_TO_BSP_PREMISE_UNVERIFIED = 117; + E2E_IDENTITY_UNAVAILABLE = 118; + GROUP_CREATING = 119; + GROUP_CREATE_FAILED = 120; + GROUP_BOUNCED = 121; + BLOCK_CONTACT = 122; + EPHEMERAL_SETTING_NOT_APPLIED = 123; + SYNC_FAILED = 124; + SYNCING = 125; + BIZ_PRIVACY_MODE_INIT_FB = 126; + BIZ_PRIVACY_MODE_INIT_BSP = 127; + BIZ_PRIVACY_MODE_TO_FB = 128; + BIZ_PRIVACY_MODE_TO_BSP = 129; + DISAPPEARING_MODE = 130; + E2E_DEVICE_FETCH_FAILED = 131; + ADMIN_REVOKE = 132; + GROUP_INVITE_LINK_GROWTH_LOCKED = 133; + COMMUNITY_LINK_PARENT_GROUP = 134; + COMMUNITY_LINK_SIBLING_GROUP = 135; + COMMUNITY_LINK_SUB_GROUP = 136; + COMMUNITY_UNLINK_PARENT_GROUP = 137; + COMMUNITY_UNLINK_SIBLING_GROUP = 138; + COMMUNITY_UNLINK_SUB_GROUP = 139; + GROUP_PARTICIPANT_ACCEPT = 140; + GROUP_PARTICIPANT_LINKED_GROUP_JOIN = 141; + COMMUNITY_CREATE = 142; + EPHEMERAL_KEEP_IN_CHAT = 143; + GROUP_MEMBERSHIP_JOIN_APPROVAL_REQUEST = 144; + GROUP_MEMBERSHIP_JOIN_APPROVAL_MODE = 145; + INTEGRITY_UNLINK_PARENT_GROUP = 146; + COMMUNITY_PARTICIPANT_PROMOTE = 147; + COMMUNITY_PARTICIPANT_DEMOTE = 148; + COMMUNITY_PARENT_GROUP_DELETED = 149; + COMMUNITY_LINK_PARENT_GROUP_MEMBERSHIP_APPROVAL = 150; + GROUP_PARTICIPANT_JOINED_GROUP_AND_PARENT_GROUP = 151; + MASKED_THREAD_CREATED = 152; + MASKED_THREAD_UNMASKED = 153; + BIZ_CHAT_ASSIGNMENT = 154; + CHAT_PSA = 155; + CHAT_POLL_CREATION_MESSAGE = 156; + CAG_MASKED_THREAD_CREATED = 157; + COMMUNITY_PARENT_GROUP_SUBJECT_CHANGED = 158; + CAG_INVITE_AUTO_ADD = 159; + BIZ_CHAT_ASSIGNMENT_UNASSIGN = 160; + CAG_INVITE_AUTO_JOINED = 161; + SCHEDULED_CALL_START_MESSAGE = 162; + COMMUNITY_INVITE_RICH = 163; + COMMUNITY_INVITE_AUTO_ADD_RICH = 164; + SUB_GROUP_INVITE_RICH = 165; + SUB_GROUP_PARTICIPANT_ADD_RICH = 166; + COMMUNITY_LINK_PARENT_GROUP_RICH = 167; + COMMUNITY_PARTICIPANT_ADD_RICH = 168; + SILENCED_UNKNOWN_CALLER_AUDIO = 169; + SILENCED_UNKNOWN_CALLER_VIDEO = 170; + GROUP_MEMBER_ADD_MODE = 171; + GROUP_MEMBERSHIP_JOIN_APPROVAL_REQUEST_NON_ADMIN_ADD = 172; + COMMUNITY_CHANGE_DESCRIPTION = 173; + SENDER_INVITE = 174; + RECEIVER_INVITE = 175; + COMMUNITY_ALLOW_MEMBER_ADDED_GROUPS = 176; + PINNED_MESSAGE_IN_CHAT = 177; + PAYMENT_INVITE_SETUP_INVITER = 178; + PAYMENT_INVITE_SETUP_INVITEE_RECEIVE_ONLY = 179; + PAYMENT_INVITE_SETUP_INVITEE_SEND_AND_RECEIVE = 180; + LINKED_GROUP_CALL_START = 181; + REPORT_TO_ADMIN_ENABLED_STATUS = 182; + EMPTY_SUBGROUP_CREATE = 183; + SCHEDULED_CALL_CANCEL = 184; + SUBGROUP_ADMIN_TRIGGERED_AUTO_ADD_RICH = 185; + GROUP_CHANGE_RECENT_HISTORY_SHARING = 186; + PAID_MESSAGE_SERVER_CAMPAIGN_ID = 187; + GENERAL_CHAT_CREATE = 188; + GENERAL_CHAT_ADD = 189; + GENERAL_CHAT_AUTO_ADD_DISABLED = 190; + SUGGESTED_SUBGROUP_ANNOUNCE = 191; + BIZ_BOT_1P_MESSAGING_ENABLED = 192; + CHANGE_USERNAME = 193; + BIZ_COEX_PRIVACY_INIT_SELF = 194; + BIZ_COEX_PRIVACY_TRANSITION_SELF = 195; + SUPPORT_AI_EDUCATION = 196; + BIZ_BOT_3P_MESSAGING_ENABLED = 197; + REMINDER_SETUP_MESSAGE = 198; + REMINDER_SENT_MESSAGE = 199; + REMINDER_CANCEL_MESSAGE = 200; + } +} + +message WebNotificationsInfo { + optional uint64 timestamp = 2; + optional uint32 unreadChats = 3; + optional uint32 notifyMessageCount = 4; + repeated WebMessageInfo notifyMessages = 5; +} diff --git a/src/main/java/it/auties/whatsapp/api/AsyncVerificationCodeSupplier.java b/src/main/java/it/auties/whatsapp/api/AsyncVerificationCodeSupplier.java new file mode 100644 index 000000000..9f3ff07bb --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/AsyncVerificationCodeSupplier.java @@ -0,0 +1,20 @@ +package it.auties.whatsapp.api; + + +import java.util.concurrent.CompletableFuture; +import java.util.function.Supplier; + +/** + * An interface to represent a supplier that returns a code wrapped in a CompletableFuture + */ +public interface AsyncVerificationCodeSupplier extends Supplier> { + /** + * Creates an asynchronous supplier from a synchronous one + * + * @param supplier a non-null supplier + * @return a non-null async supplier + */ + static AsyncVerificationCodeSupplier of(Supplier supplier) { + return () -> CompletableFuture.completedFuture(supplier.get()); + } +} diff --git a/src/main/java/it/auties/whatsapp/api/ClientType.java b/src/main/java/it/auties/whatsapp/api/ClientType.java new file mode 100644 index 000000000..91a09cfb7 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/ClientType.java @@ -0,0 +1,26 @@ +package it.auties.whatsapp.api; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; + +/** + * The constants of this enumerated type describe the various types of API that can be used to make + * {@link Whatsapp} work + */ +public enum ClientType implements ProtobufEnum { + /** + * A standalone client that requires the QR code to be scanned by its companion on log-in Reversed + * from Whatsapp Web Client + */ + WEB(0), + /** + * A standalone client that requires an SMS code sent to the companion's phone number on log-in + * Reversed from KaiOS Mobile App + */ + MOBILE(1); + + final int index; + ClientType(@ProtobufEnumIndex int index) { + this.index = index; + } +} diff --git a/src/main/java/it/auties/whatsapp/api/ConnectionBuilder.java b/src/main/java/it/auties/whatsapp/api/ConnectionBuilder.java new file mode 100644 index 000000000..8f99a9dd5 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/ConnectionBuilder.java @@ -0,0 +1,203 @@ +package it.auties.whatsapp.api; + +import it.auties.whatsapp.controller.ControllerSerializer; +import it.auties.whatsapp.controller.KeysBuilder; +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.controller.StoreKeysPair; +import it.auties.whatsapp.model.mobile.PhoneNumber; +import it.auties.whatsapp.model.mobile.SixPartsKeys; + +import java.util.List; +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; + +/** + * A builder to specify the type of connection to use + * + * @param the type of the newsletters + */ +@SuppressWarnings("unused") +public final class ConnectionBuilder> { + private final ClientType clientType; + private ControllerSerializer serializer; + + ConnectionBuilder(ClientType clientType) { + this.clientType = clientType; + this.serializer = ControllerSerializer.toProtobuf(); + } + + /** + * Uses a custom serializer + * + * @param serializer the non-null serializer to use + * @return the same instance for chaining + */ + public ConnectionBuilder serializer(ControllerSerializer serializer) { + this.serializer = serializer; + return this; + } + + /** + * Creates a new connection using a random uuid + * + * @return a non-null options selector + */ + public T newConnection() { + return newConnection(UUID.randomUUID()); + } + + /** + * Creates a new connection using a unique identifier + * If a session with the given id already whatsappOldEligible, it will be retrieved. + * Otherwise, a new one will be created. + * + * @param uuid the nullable uuid to use to create the connection + * @return a non-null options selector + */ + public T newConnection(UUID uuid) { + var sessionUuid = Objects.requireNonNullElseGet(uuid, UUID::randomUUID); + var sessionStoreAndKeys = serializer.deserializeStoreKeysPair(sessionUuid, null, null, clientType) + .orElseGet(() -> serializer.newStoreKeysPair(sessionUuid, null, null, clientType)); + return createConnection(sessionStoreAndKeys); + } + + /** + * Creates a new connection using a phone number + * If a session with the given phone number already whatsappOldEligible, it will be retrieved. + * Otherwise, a new one will be created. + * + * @param phoneNumber the nullable uuid to use to create the connection + * @return a non-null options selector + */ + public T newConnection(long phoneNumber) { + var sessionStoreAndKeys = serializer.deserializeStoreKeysPair(null, phoneNumber, null, clientType) + .orElseGet(() -> serializer.newStoreKeysPair(UUID.randomUUID(), phoneNumber, null, clientType)); + return createConnection(sessionStoreAndKeys); + } + + /** + * Creates a new connection using an alias + * If a session with the given alias already whatsappOldEligible, it will be retrieved. + * Otherwise, a new one will be created. + * + * @param alias the nullable alias to use to create the connection + * @return a non-null options selector + */ + public T newConnection(String alias) { + var sessionStoreAndKeys = serializer.deserializeStoreKeysPair(null, null, alias, clientType) + .orElseGet(() -> serializer.newStoreKeysPair(UUID.randomUUID(), null, alias != null ? List.of(alias) : null, clientType)); + return createConnection(sessionStoreAndKeys); + } + + /** + * Creates a new connection using a six parts key representation + * + * @param sixParts the non-null six parts to use to create the connection + * @return a non-null options selector + */ + public T newConnection(SixPartsKeys sixParts) { + var serialized = serializer.deserializeStoreKeysPair(null, sixParts.phoneNumber().number(), null, ClientType.MOBILE); + if(serialized.isPresent()) { + return createConnection(serialized.get()); + } + + var uuid = UUID.randomUUID(); + var keys = new KeysBuilder() + .uuid(uuid) + .phoneNumber(sixParts.phoneNumber()) + .noiseKeyPair(sixParts.noiseKeyPair()) + .identityKeyPair(sixParts.identityKeyPair()) + .identityId(sixParts.identityId()) + .registered(true) + .build(); + keys.setSerializer(serializer); + var phoneNumber = keys.phoneNumber() + .map(PhoneNumber::number) + .orElse(null); + var store = Store.newStore(uuid, phoneNumber, null, ClientType.MOBILE); + store.setSerializer(serializer); + return createConnection(new StoreKeysPair(store, keys)); + } + + /** + * Creates a new connection from the first connection that was serialized + * If no connection is available, a new one will be created + * + * @return a non-null options selector + */ + public T firstConnection() { + return newConnection(serializer.listIds(clientType).peekFirst()); + } + + /** + * Creates a new connection from the last connection that was serialized + * If no connection is available, a new one will be created + * + * @return a non-null options selector + */ + public T lastConnection() { + return newConnection(serializer.listIds(clientType).peekLast()); + } + + /** + * Creates a new connection from the last connection that was serialized + * If no connection is available, an empty optional will be returned + * + * @return a non-null options selector + */ + public Optional newOptionalConnection(UUID uuid) { + var sessionUuid = Objects.requireNonNullElseGet(uuid, UUID::randomUUID); + return serializer.deserializeStoreKeysPair(sessionUuid, null, null, clientType) + .map(this::createConnection); + } + + /** + * Creates a new connection from the last connection that was serialized + * If no connection is available, an empty optional will be returned + * + * @return a non-null options selector + */ + public Optional newOptionalConnection(Long phoneNumber) { + return serializer.deserializeStoreKeysPair(null, phoneNumber, null, clientType) + .map(this::createConnection); + } + + /** + * Creates a new connection using an alias + * If no connection is available, an empty optional will be returned + * + * @param alias the nullable alias to use to create the connection + * @return a non-null options selector + */ + public Optional newOptionalConnection(String alias) { + return serializer.deserializeStoreKeysPair(null, null, alias, clientType) + .map(this::createConnection); + } + + /** + * Creates a new connection from the first connection that was serialized + * + * @return an optional + */ + public Optional firstOptionalConnection() { + return newOptionalConnection(serializer.listIds(clientType).peekFirst()); + } + + /** + * Creates a new connection from the last connection that was serialized + * + * @return an optional + */ + public Optional lastOptionalConnection() { + return newOptionalConnection(serializer.listIds(clientType).peekLast()); + } + + @SuppressWarnings("unchecked") + private T createConnection(StoreKeysPair sessionStoreAndKeys) { + return (T) switch (clientType) { + case WEB -> new WebOptionsBuilder(sessionStoreAndKeys.store(), sessionStoreAndKeys.keys()); + case MOBILE -> new MobileOptionsBuilder(sessionStoreAndKeys.store(), sessionStoreAndKeys.keys()); + }; + } +} diff --git a/src/main/java/it/auties/whatsapp/api/ConnectionType.java b/src/main/java/it/auties/whatsapp/api/ConnectionType.java new file mode 100644 index 000000000..bf7170c25 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/ConnectionType.java @@ -0,0 +1,25 @@ +package it.auties.whatsapp.api; + +/** + * The constants of this enumerated type describe the various types of connections that can be initialized + */ +public enum ConnectionType { + /** + * Creates a new connection using a unique identifier + * If no uuid is provided, a new connection will be created + * If the connection doesn't exist, a new one will be created + */ + NEW, + + /** + * Creates a new connection from the first session that was serialized + * If no connection is available, a new one will be created + */ + FIRST, + + /** + * Creates a new connection from the last session that was serialized + * If no connection is available, a new one will be created + */ + LAST +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/api/DisconnectReason.java b/src/main/java/it/auties/whatsapp/api/DisconnectReason.java new file mode 100644 index 000000000..8e68c33ea --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/DisconnectReason.java @@ -0,0 +1,27 @@ +package it.auties.whatsapp.api; + +/** + * The constants of this enumerated type describe the various reasons for which a session can be + * terminated + */ +public enum DisconnectReason { + /** + * Default errorReason + */ + DISCONNECTED, + + /** + * Reconnect + */ + RECONNECTING, + + /** + * Logged out + */ + LOGGED_OUT, + + /** + * Session restore + */ + RESTORE +} diff --git a/src/main/java/it/auties/whatsapp/api/Emoji.java b/src/main/java/it/auties/whatsapp/api/Emoji.java new file mode 100644 index 000000000..b9975eed7 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/Emoji.java @@ -0,0 +1,1894 @@ +package it.auties.whatsapp.api; + +/** + * A list of all emojis supported by Whatsapp + * Source + */ +@SuppressWarnings("SpellCheckingInspection") +public enum Emoji { + GRINNING_FACE("😀"), + GRINNING_FACE_WITH_BIG_EYES("😃"), + GRINNING_FACE_WITH_SMILING_EYES("😄"), + BEAMING_FACE_WITH_SMILING_EYES("😁"), + GRINNING_SQUINTING_FACE("😆"), + GRINNING_FACE_WITH_SWEAT("😅"), + ROLLING_ON_THE_FLOOR_LAUGHING("🤣"), + FACE_WITH_TEARS_OF_JOY("😂"), + SLIGHTLY_SMILING_FACE("🙂"), + UPSIDE_DOWN_FACE("🙃"), + MELTING_FACE("🫠"), + WINKING_FACE("😉"), + SMILING_FACE_WITH_SMILING_EYES("😊"), + SMILING_FACE_WITH_HALO("😇"), + SMILING_FACE_WITH_HEARTS("🥰"), + SMILING_FACE_WITH_HEART_EYES("😍"), + STAR_STRUCK("🤩"), + FACE_BLOWING_A_KISS("😘"), + KISSING_FACE("😗"), + SMILING_FACE("☺"), + KISSING_FACE_WITH_CLOSED_EYES("😚"), + KISSING_FACE_WITH_SMILING_EYES("😙"), + SMILING_FACE_WITH_TEAR("🥲"), + FACE_SAVORING_FOOD("😋"), + FACE_WITH_TONGUE("😛"), + WINKING_FACE_WITH_TONGUE("😜"), + ZANY_FACE("🤪"), + SQUINTING_FACE_WITH_TONGUE("😝"), + MONEY_MOUTH_FACE("🤑"), + SMILING_FACE_WITH_OPEN_HANDS("🤗"), + FACE_WITH_HAND_OVER_MOUTH("🤭"), + FACE_WITH_OPEN_EYES_AND_HAND_OVER_MOUTH("🫢"), + FACE_WITH_PEEKING_EYE("🫣"), + SHUSHING_FACE("🤫"), + THINKING_FACE("🤔"), + SALUTING_FACE("🫡"), + ZIPPER_MOUTH_FACE("🤐"), + FACE_WITH_RAISED_EYEBROW("🤨"), + NEUTRAL_FACE("😐"), + EXPRESSIONLESS_FACE("😑"), + FACE_WITHOUT_MOUTH("😶"), + DOTTED_LINE_FACE("🫥"), + FACE_IN_CLOUDS("😶‍🌫️"), + SMIRKING_FACE("😏"), + UNAMUSED_FACE("😒"), + FACE_WITH_ROLLING_EYES("🙄"), + GRIMACING_FACE("😬"), + FACE_EXHALING("😮‍💨"), + LYING_FACE("🤥"), + SHAKING_FACE("🫨"), + RELIEVED_FACE("😌"), + PENSIVE_FACE("😔"), + SLEEPY_FACE("😪"), + DROOLING_FACE("🤤"), + SLEEPING_FACE("😴"), + FACE_WITH_MEDICAL_MASK("😷"), + FACE_WITH_THERMOMETER("🤒"), + FACE_WITH_HEAD_BANDAGE("🤕"), + NAUSEATED_FACE("🤢"), + FACE_VOMITING("🤮"), + SNEEZING_FACE("🤧"), + HOT_FACE("🥵"), + COLD_FACE("🥶"), + WOOZY_FACE("🥴"), + FACE_WITH_CROSSED_OUT_EYES("😵"), + FACE_WITH_SPIRAL_EYES("😵‍💫"), + EXPLODING_HEAD("🤯"), + COWBOY_HAT_FACE("🤠"), + PARTYING_FACE("🥳"), + DISGUISED_FACE("🥸"), + SMILING_FACE_WITH_SUNGLASSES("😎"), + NERD_FACE("🤓"), + FACE_WITH_MONOCLE("🧐"), + CONFUSED_FACE("😕"), + FACE_WITH_DIAGONAL_MOUTH("🫤"), + WORRIED_FACE("😟"), + SLIGHTLY_FROWNING_FACE("🙁"), + FROWNING_FACE("☹"), + FACE_WITH_OPEN_MOUTH("😮"), + HUSHED_FACE("😯"), + ASTONISHED_FACE("😲"), + FLUSHED_FACE("😳"), + PLEADING_FACE("🥺"), + FACE_HOLDING_BACK_TEARS("🥹"), + FROWNING_FACE_WITH_OPEN_MOUTH("😦"), + ANGUISHED_FACE("😧"), + FEARFUL_FACE("😨"), + ANXIOUS_FACE_WITH_SWEAT("😰"), + SAD_BUT_RELIEVED_FACE("😥"), + CRYING_FACE("😢"), + LOUDLY_CRYING_FACE("😭"), + FACE_SCREAMING_IN_FEAR("😱"), + CONFOUNDED_FACE("😖"), + PERSEVERING_FACE("😣"), + DISAPPOINTED_FACE("😞"), + DOWNCAST_FACE_WITH_SWEAT("😓"), + WEARY_FACE("😩"), + TIRED_FACE("😫"), + YAWNING_FACE("🥱"), + FACE_WITH_STEAM_FROM_NOSE("😤"), + ENRAGED_FACE("😡"), + ANGRY_FACE("😠"), + FACE_WITH_SYMBOLS_ON_MOUTH("🤬"), + SMILING_FACE_WITH_HORNS("😈"), + ANGRY_FACE_WITH_HORNS("👿"), + SKULL("💀"), + SKULL_AND_CROSSBONES("☠"), + PILE_OF_POO("💩"), + CLOWN_FACE("🤡"), + OGRE("👹"), + GOBLIN("👺"), + GHOST("👻"), + ALIEN("👽"), + ALIEN_MONSTER("👾"), + ROBOT("🤖"), + GRINNING_CAT("😺"), + GRINNING_CAT_WITH_SMILING_EYES("😸"), + CAT_WITH_TEARS_OF_JOY("😹"), + SMILING_CAT_WITH_HEART_EYES("😻"), + CAT_WITH_WRY_SMILE("😼"), + KISSING_CAT("😽"), + WEARY_CAT("🙀"), + CRYING_CAT("😿"), + POUTING_CAT("😾"), + SEE_NO_EVIL_MONKEY("🙈"), + HEAR_NO_EVIL_MONKEY("🙉"), + SPEAK_NO_EVIL_MONKEY("🙊"), + LOVE_LETTER("💌"), + HEART_WITH_ARROW("💘"), + HEART_WITH_RIBBON("💝"), + SPARKLING_HEART("💖"), + GROWING_HEART("💗"), + BEATING_HEART("💓"), + REVOLVING_HEARTS("💞"), + TWO_HEARTS("💕"), + HEART_DECORATION("💟"), + HEART_EXCLAMATION("❣"), + BROKEN_HEART("💔"), + HEART_ON_FIRE("❤️‍🔥"), + MENDING_HEART("❤️‍🩹"), + RED_HEART("❤"), + PINK_HEART("🩷"), + ORANGE_HEART("🧡"), + YELLOW_HEART("💛"), + GREEN_HEART("💚"), + BLUE_HEART("💙"), + LIGHT_BLUE_HEART("🩵"), + PURPLE_HEART("💜"), + BROWN_HEART("🤎"), + BLACK_HEART("🖤"), + GREY_HEART("🩶"), + WHITE_HEART("🤍"), + KISS_MARK("💋"), + HUNDRED_POINTS("💯"), + ANGER_SYMBOL("💢"), + COLLISION("💥"), + DIZZY("💫"), + SWEAT_DROPLETS("💦"), + DASHING_AWAY("💨"), + HOLE("🕳"), + SPEECH_BALLOON("💬"), + EYE_IN_SPEECH_BUBBLE("👁️‍🗨️"), + LEFT_SPEECH_BUBBLE("🗨"), + RIGHT_ANGER_BUBBLE("🗯"), + THOUGHT_BALLOON("💭"), + ZZZ("💤"), + WAVING_HAND("👋"), + RAISED_BACK_OF_HAND("🤚"), + HAND_WITH_FINGERS_SPLAYED("🖐"), + RAISED_HAND("✋"), + VULCAN_SALUTE("🖖"), + RIGHTWARDS_HAND("🫱"), + LEFTWARDS_HAND("🫲"), + PALM_DOWN_HAND("🫳"), + PALM_UP_HAND("🫴"), + LEFTWARDS_PUSHING_HAND("🫷"), + RIGHTWARDS_PUSHING_HAND("🫸"), + OK_HAND("👌"), + PINCHED_FINGERS("🤌"), + PINCHING_HAND("🤏"), + VICTORY_HAND("✌"), + CROSSED_FINGERS("🤞"), + HAND_WITH_INDEX_FINGER_AND_THUMB_CROSSED("🫰"), + LOVE_YOU_GESTURE("🤟"), + SIGN_OF_THE_HORNS("🤘"), + CALL_ME_HAND("🤙"), + BACKHAND_INDEX_POINTING_LEFT("👈"), + BACKHAND_INDEX_POINTING_RIGHT("👉"), + BACKHAND_INDEX_POINTING_UP("👆"), + MIDDLE_FINGER("🖕"), + BACKHAND_INDEX_POINTING_DOWN("👇"), + INDEX_POINTING_UP("☝"), + INDEX_POINTING_AT_THE_VIEWER("🫵"), + THUMBS_UP("👍"), + THUMBS_DOWN("👎"), + RAISED_FIST("✊"), + ONCOMING_FIST("👊"), + LEFT_FACING_FIST("🤛"), + RIGHT_FACING_FIST("🤜"), + CLAPPING_HANDS("👏"), + RAISING_HANDS("🙌"), + HEART_HANDS("🫶"), + OPEN_HANDS("👐"), + PALMS_UP_TOGETHER("🤲"), + HANDSHAKE("🤝"), + FOLDED_HANDS("🙏"), + WRITING_HAND("✍"), + NAIL_POLISH("💅"), + SELFIE("🤳"), + FLEXED_BICEPS("💪"), + MECHANICAL_ARM("🦾"), + MECHANICAL_LEG("🦿"), + LEG("🦵"), + FOOT("🦶"), + EAR("👂"), + EAR_WITH_HEARING_AID("🦻"), + NOSE("👃"), + BRAIN("🧠"), + ANATOMICAL_HEART("🫀"), + LUNGS("🫁"), + TOOTH("🦷"), + BONE("🦴"), + EYES("👀"), + EYE("👁"), + TONGUE("👅"), + MOUTH("👄"), + BITING_LIP("🫦"), + BABY("👶"), + CHILD("🧒"), + BOY("👦"), + GIRL("👧"), + PERSON("🧑"), + PERSON_BLOND_HAIR("👱"), + MAN("👨"), + PERSON_BEARD("🧔"), + MAN_BEARD("🧔‍♂️"), + WOMAN_BEARD("🧔‍♀️"), + MAN_RED_HAIR("👨‍🦰"), + MAN_CURLY_HAIR("👨‍🦱"), + MAN_WHITE_HAIR("👨‍🦳"), + MAN_BALD("👨‍🦲"), + WOMAN("👩"), + WOMAN_RED_HAIR("👩‍🦰"), + PERSON_RED_HAIR("🧑‍🦰"), + WOMAN_CURLY_HAIR("👩‍🦱"), + PERSON_CURLY_HAIR("🧑‍🦱"), + WOMAN_WHITE_HAIR("👩‍🦳"), + PERSON_WHITE_HAIR("🧑‍🦳"), + WOMAN_BALD("👩‍🦲"), + PERSON_BALD("🧑‍🦲"), + WOMAN_BLOND_HAIR("👱‍♀️"), + MAN_BLOND_HAIR("👱‍♂️"), + OLDER_PERSON("🧓"), + OLD_MAN("👴"), + OLD_WOMAN("👵"), + PERSON_FROWNING("🙍"), + MAN_FROWNING("🙍‍♂️"), + WOMAN_FROWNING("🙍‍♀️"), + PERSON_POUTING("🙎"), + MAN_POUTING("🙎‍♂️"), + WOMAN_POUTING("🙎‍♀️"), + PERSON_GESTURING_NO("🙅"), + MAN_GESTURING_NO("🙅‍♂️"), + WOMAN_GESTURING_NO("🙅‍♀️"), + PERSON_GESTURING_OK("🙆"), + MAN_GESTURING_OK("🙆‍♂️"), + WOMAN_GESTURING_OK("🙆‍♀️"), + PERSON_TIPPING_HAND("💁"), + MAN_TIPPING_HAND("💁‍♂️"), + WOMAN_TIPPING_HAND("💁‍♀️"), + PERSON_RAISING_HAND("🙋"), + MAN_RAISING_HAND("🙋‍♂️"), + WOMAN_RAISING_HAND("🙋‍♀️"), + DEAF_PERSON("🧏"), + DEAF_MAN("🧏‍♂️"), + DEAF_WOMAN("🧏‍♀️"), + PERSON_BOWING("🙇"), + MAN_BOWING("🙇‍♂️"), + WOMAN_BOWING("🙇‍♀️"), + PERSON_FACEPALMING("🤦"), + MAN_FACEPALMING("🤦‍♂️"), + WOMAN_FACEPALMING("🤦‍♀️"), + PERSON_SHRUGGING("🤷"), + MAN_SHRUGGING("🤷‍♂️"), + WOMAN_SHRUGGING("🤷‍♀️"), + HEALTH_WORKER("🧑‍⚕️"), + MAN_HEALTH_WORKER("👨‍⚕️"), + WOMAN_HEALTH_WORKER("👩‍⚕️"), + STUDENT("🧑‍🎓"), + MAN_STUDENT("👨‍🎓"), + WOMAN_STUDENT("👩‍🎓"), + TEACHER("🧑‍🏫"), + MAN_TEACHER("👨‍🏫"), + WOMAN_TEACHER("👩‍🏫"), + JUDGE("🧑‍⚖️"), + MAN_JUDGE("👨‍⚖️"), + WOMAN_JUDGE("👩‍⚖️"), + FARMER("🧑‍🌾"), + MAN_FARMER("👨‍🌾"), + WOMAN_FARMER("👩‍🌾"), + COOK("🧑‍🍳"), + MAN_COOK("👨‍🍳"), + WOMAN_COOK("👩‍🍳"), + MECHANIC("🧑‍🔧"), + MAN_MECHANIC("👨‍🔧"), + WOMAN_MECHANIC("👩‍🔧"), + FACTORY_WORKER("🧑‍🏭"), + MAN_FACTORY_WORKER("👨‍🏭"), + WOMAN_FACTORY_WORKER("👩‍🏭"), + OFFICE_WORKER("🧑‍💼"), + MAN_OFFICE_WORKER("👨‍💼"), + WOMAN_OFFICE_WORKER("👩‍💼"), + SCIENTIST("🧑‍🔬"), + MAN_SCIENTIST("👨‍🔬"), + WOMAN_SCIENTIST("👩‍🔬"), + TECHNOLOGIST("🧑‍💻"), + MAN_TECHNOLOGIST("👨‍💻"), + WOMAN_TECHNOLOGIST("👩‍💻"), + SINGER("🧑‍🎤"), + MAN_SINGER("👨‍🎤"), + WOMAN_SINGER("👩‍🎤"), + ARTIST("🧑‍🎨"), + MAN_ARTIST("👨‍🎨"), + WOMAN_ARTIST("👩‍🎨"), + PILOT("🧑‍✈️"), + MAN_PILOT("👨‍✈️"), + WOMAN_PILOT("👩‍✈️"), + ASTRONAUT("🧑‍🚀"), + MAN_ASTRONAUT("👨‍🚀"), + WOMAN_ASTRONAUT("👩‍🚀"), + FIREFIGHTER("🧑‍🚒"), + MAN_FIREFIGHTER("👨‍🚒"), + WOMAN_FIREFIGHTER("👩‍🚒"), + POLICE_OFFICER("👮"), + MAN_POLICE_OFFICER("👮‍♂️"), + WOMAN_POLICE_OFFICER("👮‍♀️"), + DETECTIVE("🕵"), + MAN_DETECTIVE("🕵️‍♂️"), + WOMAN_DETECTIVE("🕵️‍♀️"), + GUARD("💂"), + MAN_GUARD("💂‍♂️"), + WOMAN_GUARD("💂‍♀️"), + NINJA("🥷"), + CONSTRUCTION_WORKER("👷"), + MAN_CONSTRUCTION_WORKER("👷‍♂️"), + WOMAN_CONSTRUCTION_WORKER("👷‍♀️"), + PERSON_WITH_CROWN("🫅"), + PRINCE("🤴"), + PRINCESS("👸"), + PERSON_WEARING_TURBAN("👳"), + MAN_WEARING_TURBAN("👳‍♂️"), + WOMAN_WEARING_TURBAN("👳‍♀️"), + PERSON_WITH_SKULLCAP("👲"), + WOMAN_WITH_HEADSCARF("🧕"), + PERSON_IN_TUXEDO("🤵"), + MAN_IN_TUXEDO("🤵‍♂️"), + WOMAN_IN_TUXEDO("🤵‍♀️"), + PERSON_WITH_VEIL("👰"), + MAN_WITH_VEIL("👰‍♂️"), + WOMAN_WITH_VEIL("👰‍♀️"), + PREGNANT_WOMAN("🤰"), + PREGNANT_MAN("🫃"), + PREGNANT_PERSON("🫄"), + BREAST_FEEDING("🤱"), + WOMAN_FEEDING_BABY("👩‍🍼"), + MAN_FEEDING_BABY("👨‍🍼"), + PERSON_FEEDING_BABY("🧑‍🍼"), + BABY_ANGEL("👼"), + SANTA_CLAUS("🎅"), + MRS__CLAUS("🤶"), + MX_CLAUS("🧑‍🎄"), + SUPERHERO("🦸"), + MAN_SUPERHERO("🦸‍♂️"), + WOMAN_SUPERHERO("🦸‍♀️"), + SUPERVILLAIN("🦹"), + MAN_SUPERVILLAIN("🦹‍♂️"), + WOMAN_SUPERVILLAIN("🦹‍♀️"), + MAGE("🧙"), + MAN_MAGE("🧙‍♂️"), + WOMAN_MAGE("🧙‍♀️"), + FAIRY("🧚"), + MAN_FAIRY("🧚‍♂️"), + WOMAN_FAIRY("🧚‍♀️"), + VAMPIRE("🧛"), + MAN_VAMPIRE("🧛‍♂️"), + WOMAN_VAMPIRE("🧛‍♀️"), + MERPERSON("🧜"), + MERMAN("🧜‍♂️"), + MERMAID("🧜‍♀️"), + ELF("🧝"), + MAN_ELF("🧝‍♂️"), + WOMAN_ELF("🧝‍♀️"), + GENIE("🧞"), + MAN_GENIE("🧞‍♂️"), + WOMAN_GENIE("🧞‍♀️"), + ZOMBIE("🧟"), + MAN_ZOMBIE("🧟‍♂️"), + WOMAN_ZOMBIE("🧟‍♀️"), + TROLL("🧌"), + PERSON_GETTING_MASSAGE("💆"), + MAN_GETTING_MASSAGE("💆‍♂️"), + WOMAN_GETTING_MASSAGE("💆‍♀️"), + PERSON_GETTING_HAIRCUT("💇"), + MAN_GETTING_HAIRCUT("💇‍♂️"), + WOMAN_GETTING_HAIRCUT("💇‍♀️"), + PERSON_WALKING("🚶"), + MAN_WALKING("🚶‍♂️"), + WOMAN_WALKING("🚶‍♀️"), + PERSON_STANDING("🧍"), + MAN_STANDING("🧍‍♂️"), + WOMAN_STANDING("🧍‍♀️"), + PERSON_KNEELING("🧎"), + MAN_KNEELING("🧎‍♂️"), + WOMAN_KNEELING("🧎‍♀️"), + PERSON_WITH_WHITE_CANE("🧑‍🦯"), + MAN_WITH_WHITE_CANE("👨‍🦯"), + WOMAN_WITH_WHITE_CANE("👩‍🦯"), + PERSON_IN_MOTORIZED_WHEELCHAIR("🧑‍🦼"), + MAN_IN_MOTORIZED_WHEELCHAIR("👨‍🦼"), + WOMAN_IN_MOTORIZED_WHEELCHAIR("👩‍🦼"), + PERSON_IN_MANUAL_WHEELCHAIR("🧑‍🦽"), + MAN_IN_MANUAL_WHEELCHAIR("👨‍🦽"), + WOMAN_IN_MANUAL_WHEELCHAIR("👩‍🦽"), + PERSON_RUNNING("🏃"), + MAN_RUNNING("🏃‍♂️"), + WOMAN_RUNNING("🏃‍♀️"), + WOMAN_DANCING("💃"), + MAN_DANCING("🕺"), + PERSON_IN_SUIT_LEVITATING("🕴"), + PEOPLE_WITH_BUNNY_EARS("👯"), + MEN_WITH_BUNNY_EARS("👯‍♂️"), + WOMEN_WITH_BUNNY_EARS("👯‍♀️"), + PERSON_IN_STEAMY_ROOM("🧖"), + MAN_IN_STEAMY_ROOM("🧖‍♂️"), + WOMAN_IN_STEAMY_ROOM("🧖‍♀️"), + PERSON_CLIMBING("🧗"), + MAN_CLIMBING("🧗‍♂️"), + WOMAN_CLIMBING("🧗‍♀️"), + PERSON_FENCING("🤺"), + HORSE_RACING("🏇"), + SKIER("⛷"), + SNOWBOARDER("🏂"), + PERSON_GOLFING("🏌"), + MAN_GOLFING("🏌️‍♂️"), + WOMAN_GOLFING("🏌️‍♀️"), + PERSON_SURFING("🏄"), + MAN_SURFING("🏄‍♂️"), + WOMAN_SURFING("🏄‍♀️"), + PERSON_ROWING_BOAT("🚣"), + MAN_ROWING_BOAT("🚣‍♂️"), + WOMAN_ROWING_BOAT("🚣‍♀️"), + PERSON_SWIMMING("🏊"), + MAN_SWIMMING("🏊‍♂️"), + WOMAN_SWIMMING("🏊‍♀️"), + PERSON_BOUNCING_BALL("⛹"), + MAN_BOUNCING_BALL("⛹️‍♂️"), + WOMAN_BOUNCING_BALL("⛹️‍♀️"), + PERSON_LIFTING_WEIGHTS("🏋"), + MAN_LIFTING_WEIGHTS("🏋️‍♂️"), + WOMAN_LIFTING_WEIGHTS("🏋️‍♀️"), + PERSON_BIKING("🚴"), + MAN_BIKING("🚴‍♂️"), + WOMAN_BIKING("🚴‍♀️"), + PERSON_MOUNTAIN_BIKING("🚵"), + MAN_MOUNTAIN_BIKING("🚵‍♂️"), + WOMAN_MOUNTAIN_BIKING("🚵‍♀️"), + PERSON_CARTWHEELING("🤸"), + MAN_CARTWHEELING("🤸‍♂️"), + WOMAN_CARTWHEELING("🤸‍♀️"), + PEOPLE_WRESTLING("🤼"), + MEN_WRESTLING("🤼‍♂️"), + WOMEN_WRESTLING("🤼‍♀️"), + PERSON_PLAYING_WATER_POLO("🤽"), + MAN_PLAYING_WATER_POLO("🤽‍♂️"), + WOMAN_PLAYING_WATER_POLO("🤽‍♀️"), + PERSON_PLAYING_HANDBALL("🤾"), + MAN_PLAYING_HANDBALL("🤾‍♂️"), + WOMAN_PLAYING_HANDBALL("🤾‍♀️"), + PERSON_JUGGLING("🤹"), + MAN_JUGGLING("🤹‍♂️"), + WOMAN_JUGGLING("🤹‍♀️"), + PERSON_IN_LOTUS_POSITION("🧘"), + MAN_IN_LOTUS_POSITION("🧘‍♂️"), + WOMAN_IN_LOTUS_POSITION("🧘‍♀️"), + PERSON_TAKING_BATH("🛀"), + PERSON_IN_BED("🛌"), + PEOPLE_HOLDING_HANDS("🧑‍🤝‍🧑"), + WOMEN_HOLDING_HANDS("👭"), + WOMAN_AND_MAN_HOLDING_HANDS("👫"), + MEN_HOLDING_HANDS("👬"), + KISS("💏"), + KISS_WOMAN_MAN("👩‍❤️‍💋‍👨"), + KISS_MAN_MAN("👨‍❤️‍💋‍👨"), + KISS_WOMAN_WOMAN("👩‍❤️‍💋‍👩"), + COUPLE_WITH_HEART("💑"), + COUPLE_WITH_HEART_WOMAN_MAN("👩‍❤️‍👨"), + COUPLE_WITH_HEART_MAN_MAN("👨‍❤️‍👨"), + COUPLE_WITH_HEART_WOMAN_WOMAN("👩‍❤️‍👩"), + FAMILY("👪"), + FAMILY_MAN_WOMAN_BOY("👨‍👩‍👦"), + FAMILY_MAN_WOMAN_GIRL("👨‍👩‍👧"), + FAMILY_MAN_WOMAN_GIRL_BOY("👨‍👩‍👧‍👦"), + FAMILY_MAN_WOMAN_BOY_BOY("👨‍👩‍👦‍👦"), + FAMILY_MAN_WOMAN_GIRL_GIRL("👨‍👩‍👧‍👧"), + FAMILY_MAN_MAN_BOY("👨‍👨‍👦"), + FAMILY_MAN_MAN_GIRL("👨‍👨‍👧"), + FAMILY_MAN_MAN_GIRL_BOY("👨‍👨‍👧‍👦"), + FAMILY_MAN_MAN_BOY_BOY("👨‍👨‍👦‍👦"), + FAMILY_MAN_MAN_GIRL_GIRL("👨‍👨‍👧‍👧"), + FAMILY_WOMAN_WOMAN_BOY("👩‍👩‍👦"), + FAMILY_WOMAN_WOMAN_GIRL("👩‍👩‍👧"), + FAMILY_WOMAN_WOMAN_GIRL_BOY("👩‍👩‍👧‍👦"), + FAMILY_WOMAN_WOMAN_BOY_BOY("👩‍👩‍👦‍👦"), + FAMILY_WOMAN_WOMAN_GIRL_GIRL("👩‍👩‍👧‍👧"), + FAMILY_MAN_BOY("👨‍👦"), + FAMILY_MAN_BOY_BOY("👨‍👦‍👦"), + FAMILY_MAN_GIRL("👨‍👧"), + FAMILY_MAN_GIRL_BOY("👨‍👧‍👦"), + FAMILY_MAN_GIRL_GIRL("👨‍👧‍👧"), + FAMILY_WOMAN_BOY("👩‍👦"), + FAMILY_WOMAN_BOY_BOY("👩‍👦‍👦"), + FAMILY_WOMAN_GIRL("👩‍👧"), + FAMILY_WOMAN_GIRL_BOY("👩‍👧‍👦"), + FAMILY_WOMAN_GIRL_GIRL("👩‍👧‍👧"), + SPEAKING_HEAD("🗣"), + BUST_IN_SILHOUETTE("👤"), + BUSTS_IN_SILHOUETTE("👥"), + PEOPLE_HUGGING("🫂"), + FOOTPRINTS("👣"), + RED_HAIR("🦰"), + CURLY_HAIR("🦱"), + WHITE_HAIR("🦳"), + BALD("🦲"), + MONKEY_FACE("🐵"), + MONKEY("🐒"), + GORILLA("🦍"), + ORANGUTAN("🦧"), + DOG_FACE("🐶"), + DOG("🐕"), + GUIDE_DOG("🦮"), + SERVICE_DOG("🐕‍🦺"), + POODLE("🐩"), + WOLF("🐺"), + FOX("🦊"), + RACCOON("🦝"), + CAT_FACE("🐱"), + CAT("🐈"), + BLACK_CAT("🐈‍⬛"), + LION("🦁"), + TIGER_FACE("🐯"), + TIGER("🐅"), + LEOPARD("🐆"), + HORSE_FACE("🐴"), + MOOSE("🫎"), + DONKEY("🫏"), + HORSE("🐎"), + UNICORN("🦄"), + ZEBRA("🦓"), + DEER("🦌"), + BISON("🦬"), + COW_FACE("🐮"), + OX("🐂"), + WATER_BUFFALO("🐃"), + COW("🐄"), + PIG_FACE("🐷"), + PIG("🐖"), + BOAR("🐗"), + PIG_NOSE("🐽"), + RAM("🐏"), + EWE("🐑"), + GOAT("🐐"), + CAMEL("🐪"), + TWO_HUMP_CAMEL("🐫"), + LLAMA("🦙"), + GIRAFFE("🦒"), + ELEPHANT("🐘"), + MAMMOTH("🦣"), + RHINOCEROS("🦏"), + HIPPOPOTAMUS("🦛"), + MOUSE_FACE("🐭"), + MOUSE("🐁"), + RAT("🐀"), + HAMSTER("🐹"), + RABBIT_FACE("🐰"), + RABBIT("🐇"), + CHIPMUNK("🐿"), + BEAVER("🦫"), + HEDGEHOG("🦔"), + BAT("🦇"), + BEAR("🐻"), + POLAR_BEAR("🐻‍❄️"), + KOALA("🐨"), + PANDA("🐼"), + SLOTH("🦥"), + OTTER("🦦"), + SKUNK("🦨"), + KANGAROO("🦘"), + BADGER("🦡"), + PAW_PRINTS("🐾"), + TURKEY("🦃"), + CHICKEN("🐔"), + ROOSTER("🐓"), + HATCHING_CHICK("🐣"), + BABY_CHICK("🐤"), + FRONT_FACING_BABY_CHICK("🐥"), + BIRD("🐦"), + PENGUIN("🐧"), + DOVE("🕊"), + EAGLE("🦅"), + DUCK("🦆"), + SWAN("🦢"), + OWL("🦉"), + DODO("🦤"), + FEATHER("🪶"), + FLAMINGO("🦩"), + PEACOCK("🦚"), + PARROT("🦜"), + WING("🪽"), + BLACK_BIRD("🐦‍⬛"), + GOOSE("🪿"), + FROG("🐸"), + CROCODILE("🐊"), + TURTLE("🐢"), + LIZARD("🦎"), + SNAKE("🐍"), + DRAGON_FACE("🐲"), + DRAGON("🐉"), + SAUROPOD("🦕"), + T_REX("🦖"), + SPOUTING_WHALE("🐳"), + WHALE("🐋"), + DOLPHIN("🐬"), + SEAL("🦭"), + FISH("🐟"), + TROPICAL_FISH("🐠"), + BLOWFISH("🐡"), + SHARK("🦈"), + OCTOPUS("🐙"), + SPIRAL_SHELL("🐚"), + CORAL("🪸"), + JELLYFISH("🪼"), + SNAIL("🐌"), + BUTTERFLY("🦋"), + BUG("🐛"), + ANT("🐜"), + HONEYBEE("🐝"), + BEETLE("🪲"), + LADY_BEETLE("🐞"), + CRICKET("🦗"), + COCKROACH("🪳"), + SPIDER("🕷"), + SPIDER_WEB("🕸"), + SCORPION("🦂"), + MOSQUITO("🦟"), + FLY("🪰"), + WORM("🪱"), + MICROBE("🦠"), + BOUQUET("💐"), + CHERRY_BLOSSOM("🌸"), + WHITE_FLOWER("💮"), + LOTUS("🪷"), + ROSETTE("🏵"), + ROSE("🌹"), + WILTED_FLOWER("🥀"), + HIBISCUS("🌺"), + SUNFLOWER("🌻"), + BLOSSOM("🌼"), + TULIP("🌷"), + HYACINTH("🪻"), + SEEDLING("🌱"), + POTTED_PLANT("🪴"), + EVERGREEN_TREE("🌲"), + DECIDUOUS_TREE("🌳"), + PALM_TREE("🌴"), + CACTUS("🌵"), + SHEAF_OF_RICE("🌾"), + HERB("🌿"), + SHAMROCK("☘"), + FOUR_LEAF_CLOVER("🍀"), + MAPLE_LEAF("🍁"), + FALLEN_LEAF("🍂"), + LEAF_FLUTTERING_IN_WIND("🍃"), + EMPTY_NEST("🪹"), + NEST_WITH_EGGS("🪺"), + MUSHROOM("🍄"), + GRAPES("🍇"), + MELON("🍈"), + WATERMELON("🍉"), + TANGERINE("🍊"), + LEMON("🍋"), + BANANA("🍌"), + PINEAPPLE("🍍"), + MANGO("🥭"), + RED_APPLE("🍎"), + GREEN_APPLE("🍏"), + PEAR("🍐"), + PEACH("🍑"), + CHERRIES("🍒"), + STRAWBERRY("🍓"), + BLUEBERRIES("🫐"), + KIWI_FRUIT("🥝"), + TOMATO("🍅"), + OLIVE("🫒"), + COCONUT("🥥"), + AVOCADO("🥑"), + EGGPLANT("🍆"), + POTATO("🥔"), + CARROT("🥕"), + EAR_OF_CORN("🌽"), + HOT_PEPPER("🌶"), + BELL_PEPPER("🫑"), + CUCUMBER("🥒"), + LEAFY_GREEN("🥬"), + BROCCOLI("🥦"), + GARLIC("🧄"), + ONION("🧅"), + PEANUTS("🥜"), + BEANS("🫘"), + CHESTNUT("🌰"), + GINGER_ROOT("🫚"), + PEA_POD("🫛"), + BREAD("🍞"), + CROISSANT("🥐"), + BAGUETTE_BREAD("🥖"), + FLATBREAD("🫓"), + PRETZEL("🥨"), + BAGEL("🥯"), + PANCAKES("🥞"), + WAFFLE("🧇"), + CHEESE_WEDGE("🧀"), + MEAT_ON_BONE("🍖"), + POULTRY_LEG("🍗"), + CUT_OF_MEAT("🥩"), + BACON("🥓"), + HAMBURGER("🍔"), + FRENCH_FRIES("🍟"), + PIZZA("🍕"), + HOT_DOG("🌭"), + SANDWICH("🥪"), + TACO("🌮"), + BURRITO("🌯"), + TAMALE("🫔"), + STUFFED_FLATBREAD("🥙"), + FALAFEL("🧆"), + EGG("🥚"), + COOKING("🍳"), + SHALLOW_PAN_OF_FOOD("🥘"), + POT_OF_FOOD("🍲"), + FONDUE("🫕"), + BOWL_WITH_SPOON("🥣"), + GREEN_SALAD("🥗"), + POPCORN("🍿"), + BUTTER("🧈"), + SALT("🧂"), + CANNED_FOOD("🥫"), + BENTO_BOX("🍱"), + RICE_CRACKER("🍘"), + RICE_BALL("🍙"), + COOKED_RICE("🍚"), + CURRY_RICE("🍛"), + STEAMING_BOWL("🍜"), + SPAGHETTI("🍝"), + ROASTED_SWEET_POTATO("🍠"), + ODEN("🍢"), + SUSHI("🍣"), + FRIED_SHRIMP("🍤"), + FISH_CAKE_WITH_SWIRL("🍥"), + MOON_CAKE("🥮"), + DANGO("🍡"), + DUMPLING("🥟"), + FORTUNE_COOKIE("🥠"), + TAKEOUT_BOX("🥡"), + CRAB("🦀"), + LOBSTER("🦞"), + SHRIMP("🦐"), + SQUID("🦑"), + OYSTER("🦪"), + SOFT_ICE_CREAM("🍦"), + SHAVED_ICE("🍧"), + ICE_CREAM("🍨"), + DOUGHNUT("🍩"), + COOKIE("🍪"), + BIRTHDAY_CAKE("🎂"), + SHORTCAKE("🍰"), + CUPCAKE("🧁"), + PIE("🥧"), + CHOCOLATE_BAR("🍫"), + CANDY("🍬"), + LOLLIPOP("🍭"), + CUSTARD("🍮"), + HONEY_POT("🍯"), + BABY_BOTTLE("🍼"), + GLASS_OF_MILK("🥛"), + HOT_BEVERAGE("☕"), + TEAPOT("🫖"), + TEACUP_WITHOUT_HANDLE("🍵"), + SAKE("🍶"), + BOTTLE_WITH_POPPING_CORK("🍾"), + WINE_GLASS("🍷"), + COCKTAIL_GLASS("🍸"), + TROPICAL_DRINK("🍹"), + BEER_MUG("🍺"), + CLINKING_BEER_MUGS("🍻"), + CLINKING_GLASSES("🥂"), + TUMBLER_GLASS("🥃"), + POURING_LIQUID("🫗"), + CUP_WITH_STRAW("🥤"), + BUBBLE_TEA("🧋"), + BEVERAGE_BOX("🧃"), + MATE("🧉"), + ICE("🧊"), + CHOPSTICKS("🥢"), + FORK_AND_KNIFE_WITH_PLATE("🍽"), + FORK_AND_KNIFE("🍴"), + SPOON("🥄"), + KITCHEN_KNIFE("🔪"), + JAR("🫙"), + AMPHORA("🏺"), + GLOBE_SHOWING_EUROPE_AFRICA("🌍"), + GLOBE_SHOWING_AMERICAS("🌎"), + GLOBE_SHOWING_ASIA_AUSTRALIA("🌏"), + GLOBE_WITH_MERIDIANS("🌐"), + WORLD_MAP("🗺"), + MAP_OF_JAPAN("🗾"), + COMPASS("🧭"), + SNOW_CAPPED_MOUNTAIN("🏔"), + MOUNTAIN("⛰"), + VOLCANO("🌋"), + MOUNT_FUJI("🗻"), + CAMPING("🏕"), + BEACH_WITH_UMBRELLA("🏖"), + DESERT("🏜"), + DESERT_ISLAND("🏝"), + NATIONAL_PARK("🏞"), + STADIUM("🏟"), + CLASSICAL_BUILDING("🏛"), + BUILDING_CONSTRUCTION("🏗"), + BRICK("🧱"), + ROCK("🪨"), + WOOD("🪵"), + HUT("🛖"), + HOUSES("🏘"), + DERELICT_HOUSE("🏚"), + HOUSE("🏠"), + HOUSE_WITH_GARDEN("🏡"), + OFFICE_BUILDING("🏢"), + JAPANESE_POST_OFFICE("🏣"), + POST_OFFICE("🏤"), + HOSPITAL("🏥"), + BANK("🏦"), + HOTEL("🏨"), + LOVE_HOTEL("🏩"), + CONVENIENCE_STORE("🏪"), + SCHOOL("🏫"), + DEPARTMENT_STORE("🏬"), + FACTORY("🏭"), + JAPANESE_CASTLE("🏯"), + CASTLE("🏰"), + WEDDING("💒"), + TOKYO_TOWER("🗼"), + STATUE_OF_LIBERTY("🗽"), + CHURCH("⛪"), + MOSQUE("🕌"), + HINDU_TEMPLE("🛕"), + SYNAGOGUE("🕍"), + SHINTO_SHRINE("⛩"), + KAABA("🕋"), + FOUNTAIN("⛲"), + TENT("⛺"), + FOGGY("🌁"), + NIGHT_WITH_STARS("🌃"), + CITYSCAPE("🏙"), + SUNRISE_OVER_MOUNTAINS("🌄"), + SUNRISE("🌅"), + CITYSCAPE_AT_DUSK("🌆"), + SUNSET("🌇"), + BRIDGE_AT_NIGHT("🌉"), + HOT_SPRINGS("♨"), + CAROUSEL_HORSE("🎠"), + PLAYGROUND_SLIDE("🛝"), + FERRIS_WHEEL("🎡"), + ROLLER_COASTER("🎢"), + BARBER_POLE("💈"), + CIRCUS_TENT("🎪"), + LOCOMOTIVE("🚂"), + RAILWAY_CAR("🚃"), + HIGH_SPEED_TRAIN("🚄"), + BULLET_TRAIN("🚅"), + TRAIN("🚆"), + METRO("🚇"), + LIGHT_RAIL("🚈"), + STATION("🚉"), + TRAM("🚊"), + MONORAIL("🚝"), + MOUNTAIN_RAILWAY("🚞"), + TRAM_CAR("🚋"), + BUS("🚌"), + ONCOMING_BUS("🚍"), + TROLLEYBUS("🚎"), + MINIBUS("🚐"), + AMBULANCE("🚑"), + FIRE_ENGINE("🚒"), + POLICE_CAR("🚓"), + ONCOMING_POLICE_CAR("🚔"), + TAXI("🚕"), + ONCOMING_TAXI("🚖"), + AUTOMOBILE("🚗"), + ONCOMING_AUTOMOBILE("🚘"), + SPORT_UTILITY_VEHICLE("🚙"), + PICKUP_TRUCK("🛻"), + DELIVERY_TRUCK("🚚"), + ARTICULATED_LORRY("🚛"), + TRACTOR("🚜"), + RACING_CAR("🏎"), + MOTORCYCLE("🏍"), + MOTOR_SCOOTER("🛵"), + MANUAL_WHEELCHAIR("🦽"), + MOTORIZED_WHEELCHAIR("🦼"), + AUTO_RICKSHAW("🛺"), + BICYCLE("🚲"), + KICK_SCOOTER("🛴"), + SKATEBOARD("🛹"), + ROLLER_SKATE("🛼"), + BUS_STOP("🚏"), + MOTORWAY("🛣"), + RAILWAY_TRACK("🛤"), + OIL_DRUM("🛢"), + FUEL_PUMP("⛽"), + WHEEL("🛞"), + POLICE_CAR_LIGHT("🚨"), + HORIZONTAL_TRAFFIC_LIGHT("🚥"), + VERTICAL_TRAFFIC_LIGHT("🚦"), + STOP_SIGN("🛑"), + CONSTRUCTION("🚧"), + ANCHOR("⚓"), + RING_BUOY("🛟"), + SAILBOAT("⛵"), + CANOE("🛶"), + SPEEDBOAT("🚤"), + PASSENGER_SHIP("🛳"), + FERRY("⛴"), + MOTOR_BOAT("🛥"), + SHIP("🚢"), + AIRPLANE("✈"), + SMALL_AIRPLANE("🛩"), + AIRPLANE_DEPARTURE("🛫"), + AIRPLANE_ARRIVAL("🛬"), + PARACHUTE("🪂"), + SEAT("💺"), + HELICOPTER("🚁"), + SUSPENSION_RAILWAY("🚟"), + MOUNTAIN_CABLEWAY("🚠"), + AERIAL_TRAMWAY("🚡"), + SATELLITE("🛰"), + ROCKET("🚀"), + FLYING_SAUCER("🛸"), + BELLHOP_BELL("🛎"), + LUGGAGE("🧳"), + HOURGLASS_DONE("⌛"), + HOURGLASS_NOT_DONE("⏳"), + WATCH("⌚"), + ALARM_CLOCK("⏰"), + STOPWATCH("⏱"), + TIMER_CLOCK("⏲"), + MANTELPIECE_CLOCK("🕰"), + TWELVE_O_CLOCK("🕛"), + TWELVE_THIRTY("🕧"), + ONE_O_CLOCK("🕐"), + ONE_THIRTY("🕜"), + TWO_O_CLOCK("🕑"), + TWO_THIRTY("🕝"), + THREE_O_CLOCK("🕒"), + THREE_THIRTY("🕞"), + FOUR_O_CLOCK("🕓"), + FOUR_THIRTY("🕟"), + FIVE_O_CLOCK("🕔"), + FIVE_THIRTY("🕠"), + SIX_O_CLOCK("🕕"), + SIX_THIRTY("🕡"), + SEVEN_O_CLOCK("🕖"), + SEVEN_THIRTY("🕢"), + EIGHT_O_CLOCK("🕗"), + EIGHT_THIRTY("🕣"), + NINE_O_CLOCK("🕘"), + NINE_THIRTY("🕤"), + TEN_O_CLOCK("🕙"), + TEN_THIRTY("🕥"), + ELEVEN_O_CLOCK("🕚"), + ELEVEN_THIRTY("🕦"), + NEW_MOON("🌑"), + WAXING_CRESCENT_MOON("🌒"), + FIRST_QUARTER_MOON("🌓"), + WAXING_GIBBOUS_MOON("🌔"), + FULL_MOON("🌕"), + WANING_GIBBOUS_MOON("🌖"), + LAST_QUARTER_MOON("🌗"), + WANING_CRESCENT_MOON("🌘"), + CRESCENT_MOON("🌙"), + NEW_MOON_FACE("🌚"), + FIRST_QUARTER_MOON_FACE("🌛"), + LAST_QUARTER_MOON_FACE("🌜"), + THERMOMETER("🌡"), + SUN("☀"), + FULL_MOON_FACE("🌝"), + SUN_WITH_FACE("🌞"), + RINGED_PLANET("🪐"), + STAR("⭐"), + GLOWING_STAR("🌟"), + SHOOTING_STAR("🌠"), + MILKY_WAY("🌌"), + CLOUD("☁"), + SUN_BEHIND_CLOUD("⛅"), + CLOUD_WITH_LIGHTNING_AND_RAIN("⛈"), + SUN_BEHIND_SMALL_CLOUD("🌤"), + SUN_BEHIND_LARGE_CLOUD("🌥"), + SUN_BEHIND_RAIN_CLOUD("🌦"), + CLOUD_WITH_RAIN("🌧"), + CLOUD_WITH_SNOW("🌨"), + CLOUD_WITH_LIGHTNING("🌩"), + TORNADO("🌪"), + FOG("🌫"), + WIND_FACE("🌬"), + CYCLONE("🌀"), + RAINBOW("🌈"), + CLOSED_UMBRELLA("🌂"), + UMBRELLA("☂"), + UMBRELLA_WITH_RAIN_DROPS("☔"), + UMBRELLA_ON_GROUND("⛱"), + HIGH_VOLTAGE("⚡"), + SNOWFLAKE("❄"), + SNOWMAN("☃"), + SNOWMAN_WITHOUT_SNOW("⛄"), + COMET("☄"), + FIRE("🔥"), + DROPLET("💧"), + WATER_WAVE("🌊"), + JACK_O_LANTERN("🎃"), + CHRISTMAS_TREE("🎄"), + FIREWORKS("🎆"), + SPARKLER("🎇"), + FIRECRACKER("🧨"), + SPARKLES("✨"), + BALLOON("🎈"), + PARTY_POPPER("🎉"), + CONFETTI_BALL("🎊"), + TANABATA_TREE("🎋"), + PINE_DECORATION("🎍"), + JAPANESE_DOLLS("🎎"), + CARP_STREAMER("🎏"), + WIND_CHIME("🎐"), + MOON_VIEWING_CEREMONY("🎑"), + RED_ENVELOPE("🧧"), + RIBBON("🎀"), + WRAPPED_GIFT("🎁"), + REMINDER_RIBBON("🎗"), + ADMISSION_TICKETS("🎟"), + TICKET("🎫"), + MILITARY_MEDAL("🎖"), + TROPHY("🏆"), + SPORTS_MEDAL("🏅"), + FIRST_PLACE_MEDAL("🥇"), + SECOND_PLACE_MEDAL("🥈"), + THIRD_PLACE_MEDAL("🥉"), + SOCCER_BALL("⚽"), + BASEBALL("⚾"), + SOFTBALL("🥎"), + BASKETBALL("🏀"), + VOLLEYBALL("🏐"), + AMERICAN_FOOTBALL("🏈"), + RUGBY_FOOTBALL("🏉"), + TENNIS("🎾"), + FLYING_DISC("🥏"), + BOWLING("🎳"), + CRICKET_GAME("🏏"), + FIELD_HOCKEY("🏑"), + ICE_HOCKEY("🏒"), + LACROSSE("🥍"), + PING_PONG("🏓"), + BADMINTON("🏸"), + BOXING_GLOVE("🥊"), + MARTIAL_ARTS_UNIFORM("🥋"), + GOAL_NET("🥅"), + FLAG_IN_HOLE("⛳"), + ICE_SKATE("⛸"), + FISHING_POLE("🎣"), + DIVING_MASK("🤿"), + RUNNING_SHIRT("🎽"), + SKIS("🎿"), + SLED("🛷"), + CURLING_STONE("🥌"), + BULLSEYE("🎯"), + YO_YO("🪀"), + KITE("🪁"), + WATER_PISTOL("🔫"), + POOL_8_BALL("🎱"), + CRYSTAL_BALL("🔮"), + MAGIC_WAND("🪄"), + VIDEO_GAME("🎮"), + JOYSTICK("🕹"), + SLOT_MACHINE("🎰"), + GAME_DIE("🎲"), + PUZZLE_PIECE("🧩"), + TEDDY_BEAR("🧸"), + PINATA("🪅"), + MIRROR_BALL("🪩"), + NESTING_DOLLS("🪆"), + SPADE_SUIT("♠"), + HEART_SUIT("♥"), + DIAMOND_SUIT("♦"), + CLUB_SUIT("♣"), + CHESS_PAWN("♟"), + JOKER("🃏"), + MAHJONG_RED_DRAGON("🀄"), + FLOWER_PLAYING_CARDS("🎴"), + PERFORMING_ARTS("🎭"), + FRAMED_PICTURE("🖼"), + ARTIST_PALETTE("🎨"), + THREAD("🧵"), + SEWING_NEEDLE("🪡"), + YARN("🧶"), + KNOT("🪢"), + GLASSES("👓"), + SUNGLASSES("🕶"), + GOGGLES("🥽"), + LAB_COAT("🥼"), + SAFETY_VEST("🦺"), + NECKTIE("👔"), + T_SHIRT("👕"), + JEANS("👖"), + SCARF("🧣"), + GLOVES("🧤"), + COAT("🧥"), + SOCKS("🧦"), + DRESS("👗"), + KIMONO("👘"), + SARI("🥻"), + ONE_PIECE_SWIMSUIT("🩱"), + BRIEFS("🩲"), + SHORTS("🩳"), + BIKINI("👙"), + WOMAN_S_CLOTHES("👚"), + FOLDING_HAND_FAN("🪭"), + PURSE("👛"), + HANDBAG("👜"), + CLUTCH_BAG("👝"), + SHOPPING_BAGS("🛍"), + BACKPACK("🎒"), + THONG_SANDAL("🩴"), + MAN_S_SHOE("👞"), + RUNNING_SHOE("👟"), + HIKING_BOOT("🥾"), + FLAT_SHOE("🥿"), + HIGH_HEELED_SHOE("👠"), + WOMAN_S_SANDAL("👡"), + BALLET_SHOES("🩰"), + WOMAN_S_BOOT("👢"), + HAIR_PICK("🪮"), + CROWN("👑"), + WOMAN_S_HAT("👒"), + TOP_HAT("🎩"), + GRADUATION_CAP("🎓"), + BILLED_CAP("🧢"), + MILITARY_HELMET("🪖"), + RESCUE_WORKER_S_HELMET("⛑"), + PRAYER_BEADS("📿"), + LIPSTICK("💄"), + RING("💍"), + GEM_STONE("💎"), + MUTED_SPEAKER("🔇"), + SPEAKER_LOW_VOLUME("🔈"), + SPEAKER_MEDIUM_VOLUME("🔉"), + SPEAKER_HIGH_VOLUME("🔊"), + LOUDSPEAKER("📢"), + MEGAPHONE("📣"), + POSTAL_HORN("📯"), + BELL("🔔"), + BELL_WITH_SLASH("🔕"), + MUSICAL_SCORE("🎼"), + MUSICAL_NOTE("🎵"), + MUSICAL_NOTES("🎶"), + STUDIO_MICROPHONE("🎙"), + LEVEL_SLIDER("🎚"), + CONTROL_KNOBS("🎛"), + MICROPHONE("🎤"), + HEADPHONE("🎧"), + RADIO("📻"), + SAXOPHONE("🎷"), + ACCORDION("🪗"), + GUITAR("🎸"), + MUSICAL_KEYBOARD("🎹"), + TRUMPET("🎺"), + VIOLIN("🎻"), + BANJO("🪕"), + DRUM("🥁"), + LONG_DRUM("🪘"), + MARACAS("🪇"), + FLUTE("🪈"), + MOBILE_PHONE("📱"), + MOBILE_PHONE_WITH_ARROW("📲"), + TELEPHONE("☎"), + TELEPHONE_RECEIVER("📞"), + PAGER("📟"), + FAX_MACHINE("📠"), + BATTERY("🔋"), + LOW_BATTERY("🪫"), + ELECTRIC_PLUG("🔌"), + LAPTOP("💻"), + DESKTOP_COMPUTER("🖥"), + PRINTER("🖨"), + KEYBOARD("⌨"), + COMPUTER_MOUSE("🖱"), + TRACKBALL("🖲"), + COMPUTER_DISK("💽"), + FLOPPY_DISK("💾"), + OPTICAL_DISK("💿"), + DVD("📀"), + ABACUS("🧮"), + MOVIE_CAMERA("🎥"), + FILM_FRAMES("🎞"), + FILM_PROJECTOR("📽"), + CLAPPER_BOARD("🎬"), + TELEVISION("📺"), + CAMERA("📷"), + CAMERA_WITH_FLASH("📸"), + VIDEO_CAMERA("📹"), + VIDEOCASSETTE("📼"), + MAGNIFYING_GLASS_TILTED_LEFT("🔍"), + MAGNIFYING_GLASS_TILTED_RIGHT("🔎"), + CANDLE("🕯"), + LIGHT_BULB("💡"), + FLASHLIGHT("🔦"), + RED_PAPER_LANTERN("🏮"), + DIYA_LAMP("🪔"), + NOTEBOOK_WITH_DECORATIVE_COVER("📔"), + CLOSED_BOOK("📕"), + OPEN_BOOK("📖"), + GREEN_BOOK("📗"), + BLUE_BOOK("📘"), + ORANGE_BOOK("📙"), + BOOKS("📚"), + NOTEBOOK("📓"), + LEDGER("📒"), + PAGE_WITH_CURL("📃"), + SCROLL("📜"), + PAGE_FACING_UP("📄"), + NEWSPAPER("📰"), + ROLLED_UP_NEWSPAPER("🗞"), + BOOKMARK_TABS("📑"), + BOOKMARK("🔖"), + LABEL("🏷"), + MONEY_BAG("💰"), + COIN("🪙"), + YEN_BANKNOTE("💴"), + DOLLAR_BANKNOTE("💵"), + EURO_BANKNOTE("💶"), + POUND_BANKNOTE("💷"), + MONEY_WITH_WINGS("💸"), + CREDIT_CARD("💳"), + RECEIPT("🧾"), + CHART_INCREASING_WITH_YEN("💹"), + ENVELOPE("✉"), + E_MAIL("📧"), + INCOMING_ENVELOPE("📨"), + ENVELOPE_WITH_ARROW("📩"), + OUTBOX_TRAY("📤"), + INBOX_TRAY("📥"), + PACKAGE("📦"), + CLOSED_MAILBOX_WITH_RAISED_FLAG("📫"), + CLOSED_MAILBOX_WITH_LOWERED_FLAG("📪"), + OPEN_MAILBOX_WITH_RAISED_FLAG("📬"), + OPEN_MAILBOX_WITH_LOWERED_FLAG("📭"), + POSTBOX("📮"), + BALLOT_BOX_WITH_BALLOT("🗳"), + PENCIL("✏"), + BLACK_NIB("✒"), + FOUNTAIN_PEN("🖋"), + PEN("🖊"), + PAINTBRUSH("🖌"), + CRAYON("🖍"), + MEMO("📝"), + BRIEFCASE("💼"), + FILE_FOLDER("📁"), + OPEN_FILE_FOLDER("📂"), + CARD_INDEX_DIVIDERS("🗂"), + CALENDAR("📅"), + TEAR_OFF_CALENDAR("📆"), + SPIRAL_NOTEPAD("🗒"), + SPIRAL_CALENDAR("🗓"), + CARD_INDEX("📇"), + CHART_INCREASING("📈"), + CHART_DECREASING("📉"), + BAR_CHART("📊"), + CLIPBOARD("📋"), + PUSHPIN("📌"), + ROUND_PUSHPIN("📍"), + PAPERCLIP("📎"), + LINKED_PAPERCLIPS("🖇"), + STRAIGHT_RULER("📏"), + TRIANGULAR_RULER("📐"), + SCISSORS("✂"), + CARD_FILE_BOX("🗃"), + FILE_CABINET("🗄"), + WASTEBASKET("🗑"), + LOCKED("🔒"), + UNLOCKED("🔓"), + LOCKED_WITH_PEN("🔏"), + LOCKED_WITH_KEY("🔐"), + KEY("🔑"), + OLD_KEY("🗝"), + HAMMER("🔨"), + AXE("🪓"), + PICK("⛏"), + HAMMER_AND_PICK("⚒"), + HAMMER_AND_WRENCH("🛠"), + DAGGER("🗡"), + CROSSED_SWORDS("⚔"), + BOMB("💣"), + BOOMERANG("🪃"), + BOW_AND_ARROW("🏹"), + SHIELD("🛡"), + CARPENTRY_SAW("🪚"), + WRENCH("🔧"), + SCREWDRIVER("🪛"), + NUT_AND_BOLT("🔩"), + GEAR("⚙"), + CLAMP("🗜"), + BALANCE_SCALE("⚖"), + WHITE_CANE("🦯"), + LINK("🔗"), + CHAINS("⛓"), + HOOK("🪝"), + TOOLBOX("🧰"), + MAGNET("🧲"), + LADDER("🪜"), + ALEMBIC("⚗"), + TEST_TUBE("🧪"), + PETRI_DISH("🧫"), + DNA("🧬"), + MICROSCOPE("🔬"), + TELESCOPE("🔭"), + SATELLITE_ANTENNA("📡"), + SYRINGE("💉"), + DROP_OF_BLOOD("🩸"), + PILL("💊"), + ADHESIVE_BANDAGE("🩹"), + CRUTCH("🩼"), + STETHOSCOPE("🩺"), + X_RAY("🩻"), + DOOR("🚪"), + ELEVATOR("🛗"), + MIRROR("🪞"), + WINDOW("🪟"), + BED("🛏"), + COUCH_AND_LAMP("🛋"), + CHAIR("🪑"), + TOILET("🚽"), + PLUNGER("🪠"), + SHOWER("🚿"), + BATHTUB("🛁"), + MOUSE_TRAP("🪤"), + RAZOR("🪒"), + LOTION_BOTTLE("🧴"), + SAFETY_PIN("🧷"), + BROOM("🧹"), + BASKET("🧺"), + ROLL_OF_PAPER("🧻"), + BUCKET("🪣"), + SOAP("🧼"), + BUBBLES("🫧"), + TOOTHBRUSH("🪥"), + SPONGE("🧽"), + FIRE_EXTINGUISHER("🧯"), + SHOPPING_CART("🛒"), + CIGARETTE("🚬"), + COFFIN("⚰"), + HEADSTONE("🪦"), + FUNERAL_URN("⚱"), + NAZAR_AMULET("🧿"), + HAMSA("🪬"), + MOAI("🗿"), + PLACARD("🪧"), + IDENTIFICATION_CARD("🪪"), + ATM_SIGN("🏧"), + LITTER_IN_BIN_SIGN("🚮"), + POTABLE_WATER("🚰"), + WHEELCHAIR_SYMBOL("♿"), + MEN_S_ROOM("🚹"), + WOMEN_S_ROOM("🚺"), + RESTROOM("🚻"), + BABY_SYMBOL("🚼"), + WATER_CLOSET("🚾"), + PASSPORT_CONTROL("🛂"), + CUSTOMS("🛃"), + BAGGAGE_CLAIM("🛄"), + LEFT_LUGGAGE("🛅"), + WARNING("⚠"), + CHILDREN_CROSSING("🚸"), + NO_ENTRY("⛔"), + PROHIBITED("🚫"), + NO_BICYCLES("🚳"), + NO_SMOKING("🚭"), + NO_LITTERING("🚯"), + NON_POTABLE_WATER("🚱"), + NO_PEDESTRIANS("🚷"), + NO_MOBILE_PHONES("📵"), + NO_ONE_UNDER_EIGHTEEN("🔞"), + RADIOACTIVE("☢"), + BIOHAZARD("☣"), + UP_ARROW("⬆"), + UP_RIGHT_ARROW("↗"), + RIGHT_ARROW("➡"), + DOWN_RIGHT_ARROW("↘"), + DOWN_ARROW("⬇"), + DOWN_LEFT_ARROW("↙"), + LEFT_ARROW("⬅"), + UP_LEFT_ARROW("↖"), + UP_DOWN_ARROW("↕"), + LEFT_RIGHT_ARROW("↔"), + RIGHT_ARROW_CURVING_LEFT("↩"), + LEFT_ARROW_CURVING_RIGHT("↪"), + RIGHT_ARROW_CURVING_UP("⤴"), + RIGHT_ARROW_CURVING_DOWN("⤵"), + CLOCKWISE_VERTICAL_ARROWS("🔃"), + COUNTERCLOCKWISE_ARROWS_BUTTON("🔄"), + BACK_ARROW("🔙"), + END_ARROW("🔚"), + ON_ARROW("🔛"), + SOON_ARROW("🔜"), + TOP_ARROW("🔝"), + PLACE_OF_WORSHIP("🛐"), + ATOM_SYMBOL("⚛"), + OM("🕉"), + STAR_OF_DAVID("✡"), + WHEEL_OF_DHARMA("☸"), + YIN_YANG("☯"), + LATIN_CROSS("✝"), + ORTHODOX_CROSS("☦"), + STAR_AND_CRESCENT("☪"), + PEACE_SYMBOL("☮"), + MENORAH("🕎"), + DOTTED_SIX_POINTED_STAR("🔯"), + KHANDA("🪯"), + ARIES("♈"), + TAURUS("♉"), + GEMINI("♊"), + CANCER("♋"), + LEO("♌"), + VIRGO("♍"), + LIBRA("♎"), + SCORPIO("♏"), + SAGITTARIUS("♐"), + CAPRICORN("♑"), + AQUARIUS("♒"), + PISCES("♓"), + OPHIUCHUS("⛎"), + SHUFFLE_TRACKS_BUTTON("🔀"), + REPEAT_BUTTON("🔁"), + REPEAT_SINGLE_BUTTON("🔂"), + PLAY_BUTTON("▶"), + FAST_FORWARD_BUTTON("⏩"), + NEXT_TRACK_BUTTON("⏭"), + PLAY_OR_PAUSE_BUTTON("⏯"), + REVERSE_BUTTON("◀"), + FAST_REVERSE_BUTTON("⏪"), + LAST_TRACK_BUTTON("⏮"), + UPWARDS_BUTTON("🔼"), + FAST_UP_BUTTON("⏫"), + DOWNWARDS_BUTTON("🔽"), + FAST_DOWN_BUTTON("⏬"), + PAUSE_BUTTON("⏸"), + STOP_BUTTON("⏹"), + RECORD_BUTTON("⏺"), + EJECT_BUTTON("⏏"), + CINEMA("🎦"), + DIM_BUTTON("🔅"), + BRIGHT_BUTTON("🔆"), + ANTENNA_BARS("📶"), + WIRELESS("🛜"), + VIBRATION_MODE("📳"), + MOBILE_PHONE_OFF("📴"), + FEMALE_SIGN("♀"), + MALE_SIGN("♂"), + TRANSGENDER_SYMBOL("⚧"), + MULTIPLY("✖"), + PLUS("➕"), + MINUS("➖"), + DIVIDE("➗"), + HEAVY_EQUALS_SIGN("🟰"), + INFINITY("♾"), + DOUBLE_EXCLAMATION_MARK("‼"), + EXCLAMATION_QUESTION_MARK("⁉"), + RED_QUESTION_MARK("❓"), + WHITE_QUESTION_MARK("❔"), + WHITE_EXCLAMATION_MARK("❕"), + RED_EXCLAMATION_MARK("❗"), + WAVY_DASH("〰"), + CURRENCY_EXCHANGE("💱"), + HEAVY_DOLLAR_SIGN("💲"), + MEDICAL_SYMBOL("⚕"), + RECYCLING_SYMBOL("♻"), + FLEUR_DE_LIS("⚜"), + TRIDENT_EMBLEM("🔱"), + NAME_BADGE("📛"), + JAPANESE_SYMBOL_FOR_BEGINNER("🔰"), + HOLLOW_RED_CIRCLE("⭕"), + CHECK_MARK_BUTTON("✅"), + CHECK_BOX_WITH_CHECK("☑"), + CHECK_MARK("✔"), + CROSS_MARK("❌"), + CROSS_MARK_BUTTON("❎"), + CURLY_LOOP("➰"), + DOUBLE_CURLY_LOOP("➿"), + PART_ALTERNATION_MARK("〽"), + EIGHT_SPOKED_ASTERISK("✳"), + EIGHT_POINTED_STAR("✴"), + SPARKLE("❇"), + COPYRIGHT("©"), + REGISTERED("®"), + TRADE_MARK("™"), + KEYCAP_SHARP("#️⃣"), + KEYCAP_ASTERISK("*️⃣"), + KEYCAP_0("0️⃣"), + KEYCAP_1("1️⃣"), + KEYCAP_2("2️⃣"), + KEYCAP_3("3️⃣"), + KEYCAP_4("4️⃣"), + KEYCAP_5("5️⃣"), + KEYCAP_6("6️⃣"), + KEYCAP_7("7️⃣"), + KEYCAP_8("8️⃣"), + KEYCAP_9("9️⃣"), + KEYCAP_10("🔟"), + INPUT_LATIN_UPPERCASE("🔠"), + INPUT_LATIN_LOWERCASE("🔡"), + INPUT_NUMBERS("🔢"), + INPUT_SYMBOLS("🔣"), + INPUT_LATIN_LETTERS("🔤"), + A_BUTTON_BLOOD_TYPE("🅰"), + AB_BUTTON_BLOOD_TYPE("🆎"), + B_BUTTON_BLOOD_TYPE("🅱"), + CL_BUTTON("🆑"), + COOL_BUTTON("🆒"), + FREE_BUTTON("🆓"), + INFORMATION("ℹ"), + ID_BUTTON("🆔"), + CIRCLED_M("Ⓜ"), + NEW_BUTTON("🆕"), + NG_BUTTON("🆖"), + O_BUTTON_BLOOD_TYPE("🅾"), + OK_BUTTON("🆗"), + P_BUTTON("🅿"), + SOS_BUTTON("🆘"), + UP_BUTTON("🆙"), + VS_BUTTON("🆚"), + JAPANESE_HERE_BUTTON("🈁"), + JAPANESE_SERVICE_CHARGE_BUTTON("🈂"), + JAPANESE_MONTHLY_AMOUNT_BUTTON("🈷"), + JAPANESE_NOT_FREE_OF_CHARGE_BUTTON("🈶"), + JAPANESE_RESERVED_BUTTON("🈯"), + JAPANESE_BARGAIN_BUTTON("🉐"), + JAPANESE_DISCOUNT_BUTTON("🈹"), + JAPANESE_FREE_OF_CHARGE_BUTTON("🈚"), + JAPANESE_PROHIBITED_BUTTON("🈲"), + JAPANESE_ACCEPTABLE_BUTTON("🉑"), + JAPANESE_APPLICATION_BUTTON("🈸"), + JAPANESE_PASSING_GRADE_BUTTON("🈴"), + JAPANESE_VACANCY_BUTTON("🈳"), + JAPANESE_CONGRATULATIONS_BUTTON("㊗"), + JAPANESE_SECRET_BUTTON("㊙"), + JAPANESE_OPEN_FOR_BUSINESS_BUTTON("🈺"), + JAPANESE_NO_VACANCY_BUTTON("🈵"), + RED_CIRCLE("🔴"), + ORANGE_CIRCLE("🟠"), + YELLOW_CIRCLE("🟡"), + GREEN_CIRCLE("🟢"), + BLUE_CIRCLE("🔵"), + PURPLE_CIRCLE("🟣"), + BROWN_CIRCLE("🟤"), + BLACK_CIRCLE("⚫"), + WHITE_CIRCLE("⚪"), + RED_SQUARE("🟥"), + ORANGE_SQUARE("🟧"), + YELLOW_SQUARE("🟨"), + GREEN_SQUARE("🟩"), + BLUE_SQUARE("🟦"), + PURPLE_SQUARE("🟪"), + BROWN_SQUARE("🟫"), + BLACK_LARGE_SQUARE("⬛"), + WHITE_LARGE_SQUARE("⬜"), + BLACK_MEDIUM_SQUARE("◼"), + WHITE_MEDIUM_SQUARE("◻"), + BLACK_MEDIUM_SMALL_SQUARE("◾"), + WHITE_MEDIUM_SMALL_SQUARE("◽"), + BLACK_SMALL_SQUARE("▪"), + WHITE_SMALL_SQUARE("▫"), + LARGE_ORANGE_DIAMOND("🔶"), + LARGE_BLUE_DIAMOND("🔷"), + SMALL_ORANGE_DIAMOND("🔸"), + SMALL_BLUE_DIAMOND("🔹"), + RED_TRIANGLE_POINTED_UP("🔺"), + RED_TRIANGLE_POINTED_DOWN("🔻"), + DIAMOND_WITH_A_DOT("💠"), + RADIO_BUTTON("🔘"), + WHITE_SQUARE_BUTTON("🔳"), + BLACK_SQUARE_BUTTON("🔲"), + CHEQUERED_FLAG("🏁"), + TRIANGULAR_FLAG("🚩"), + CROSSED_FLAGS("🎌"), + BLACK_FLAG("🏴"), + WHITE_FLAG("🏳"), + RAINBOW_FLAG("🏳️‍🌈"), + TRANSGENDER_FLAG("🏳️‍⚧️"), + PIRATE_FLAG("🏴‍☠️"), + FLAG_ASCENSION_ISLAND("🇦🇨"), + FLAG_ANDORRA("🇦🇩"), + FLAG_UNITED_ARAB_EMIRATES("🇦🇪"), + FLAG_AFGHANISTAN("🇦🇫"), + FLAG_ANTIGUA_BARBUDA("🇦🇬"), + FLAG_ANGUILLA("🇦🇮"), + FLAG_ALBANIA("🇦🇱"), + FLAG_ARMENIA("🇦🇲"), + FLAG_ANGOLA("🇦🇴"), + FLAG_ANTARCTICA("🇦🇶"), + FLAG_ARGENTINA("🇦🇷"), + FLAG_AMERICAN_SAMOA("🇦🇸"), + FLAG_AUSTRIA("🇦🇹"), + FLAG_AUSTRALIA("🇦🇺"), + FLAG_ARUBA("🇦🇼"), + FLAG_ALAND_ISLANDS("🇦🇽"), + FLAG_AZERBAIJAN("🇦🇿"), + FLAG_BOSNIA_HERZEGOVINA("🇧🇦"), + FLAG_BARBADOS("🇧🇧"), + FLAG_BANGLADESH("🇧🇩"), + FLAG_BELGIUM("🇧🇪"), + FLAG_BURKINA_FASO("🇧🇫"), + FLAG_BULGARIA("🇧🇬"), + FLAG_BAHRAIN("🇧🇭"), + FLAG_BURUNDI("🇧🇮"), + FLAG_BENIN("🇧🇯"), + FLAG_ST_BARTHELEMY("🇧🇱"), + FLAG_BERMUDA("🇧🇲"), + FLAG_BRUNEI("🇧🇳"), + FLAG_BOLIVIA("🇧🇴"), + FLAG_CARIBBEAN_NETHERLANDS("🇧🇶"), + FLAG_BRAZIL("🇧🇷"), + FLAG_BAHAMAS("🇧🇸"), + FLAG_BHUTAN("🇧🇹"), + FLAG_BOUVET_ISLAND("🇧🇻"), + FLAG_BOTSWANA("🇧🇼"), + FLAG_BELARUS("🇧🇾"), + FLAG_BELIZE("🇧🇿"), + FLAG_CANADA("🇨🇦"), + FLAG_COCOS_KEELING_ISLANDS("🇨🇨"), + FLAG_CONGO___KINSHASA("🇨🇩"), + FLAG_CENTRAL_AFRICAN_REPUBLIC("🇨🇫"), + FLAG_CONGO___BRAZZAVILLE("🇨🇬"), + FLAG_SWITZERLAND("🇨🇭"), + FLAG_COTE_IVOIRE("🇨🇮"), + FLAG_COOK_ISLANDS("🇨🇰"), + FLAG_CHILE("🇨🇱"), + FLAG_CAMEROON("🇨🇲"), + FLAG_CHINA("🇨🇳"), + FLAG_COLOMBIA("🇨🇴"), + FLAG_CLIPPERTON_ISLAND("🇨🇵"), + FLAG_COSTA_RICA("🇨🇷"), + FLAG_CUBA("🇨🇺"), + FLAG_CAPE_VERDE("🇨🇻"), + FLAG_CURACAO("🇨🇼"), + FLAG_CHRISTMAS_ISLAND("🇨🇽"), + FLAG_CYPRUS("🇨🇾"), + FLAG_CZECHIA("🇨🇿"), + FLAG_GERMANY("🇩🇪"), + FLAG_DIEGO_GARCIA("🇩🇬"), + FLAG_DJIBOUTI("🇩🇯"), + FLAG_DENMARK("🇩🇰"), + FLAG_DOMINICA("🇩🇲"), + FLAG_DOMINICAN_REPUBLIC("🇩🇴"), + FLAG_ALGERIA("🇩🇿"), + FLAG_CEUTA_MELILLA("🇪🇦"), + FLAG_ECUADOR("🇪🇨"), + FLAG_ESTONIA("🇪🇪"), + FLAG_EGYPT("🇪🇬"), + FLAG_WESTERN_SAHARA("🇪🇭"), + FLAG_ERITREA("🇪🇷"), + FLAG_SPAIN("🇪🇸"), + FLAG_ETHIOPIA("🇪🇹"), + FLAG_EUROPEAN_UNION("🇪🇺"), + FLAG_FINLAND("🇫🇮"), + FLAG_FIJI("🇫🇯"), + FLAG_FALKLAND_ISLANDS("🇫🇰"), + FLAG_MICRONESIA("🇫🇲"), + FLAG_FAROE_ISLANDS("🇫🇴"), + FLAG_FRANCE("🇫🇷"), + FLAG_GABON("🇬🇦"), + FLAG_UNITED_KINGDOM("🇬🇧"), + FLAG_GRENADA("🇬🇩"), + FLAG_GEORGIA("🇬🇪"), + FLAG_FRENCH_GUIANA("🇬🇫"), + FLAG_GUERNSEY("🇬🇬"), + FLAG_GHANA("🇬🇭"), + FLAG_GIBRALTAR("🇬🇮"), + FLAG_GREENLAND("🇬🇱"), + FLAG_GAMBIA("🇬🇲"), + FLAG_GUINEA("🇬🇳"), + FLAG_GUADELOUPE("🇬🇵"), + FLAG_EQUATORIAL_GUINEA("🇬🇶"), + FLAG_GREECE("🇬🇷"), + FLAG_SOUTH_GEORGIA_SOUTH_SANDWICH_ISLANDS("🇬🇸"), + FLAG_GUATEMALA("🇬🇹"), + FLAG_GUAM("🇬🇺"), + FLAG_GUINEA_BISSAU("🇬🇼"), + FLAG_GUYANA("🇬🇾"), + FLAG_HONG_KONG_SAR_CHINA("🇭🇰"), + FLAG_HEARD_MCDONALD_ISLANDS("🇭🇲"), + FLAG_HONDURAS("🇭🇳"), + FLAG_CROATIA("🇭🇷"), + FLAG_HAITI("🇭🇹"), + FLAG_HUNGARY("🇭🇺"), + FLAG_CANARY_ISLANDS("🇮🇨"), + FLAG_INDONESIA("🇮🇩"), + FLAG_IRELAND("🇮🇪"), + FLAG_ISRAEL("🇮🇱"), + FLAG_ISLE_OF_MAN("🇮🇲"), + FLAG_INDIA("🇮🇳"), + FLAG_BRITISH_INDIAN_OCEAN_TERRITORY("🇮🇴"), + FLAG_IRAQ("🇮🇶"), + FLAG_IRAN("🇮🇷"), + FLAG_ICELAND("🇮🇸"), + FLAG_ITALY("🇮🇹"), + FLAG_JERSEY("🇯🇪"), + FLAG_JAMAICA("🇯🇲"), + FLAG_JORDAN("🇯🇴"), + FLAG_JAPAN("🇯🇵"), + FLAG_KENYA("🇰🇪"), + FLAG_KYRGYZSTAN("🇰🇬"), + FLAG_CAMBODIA("🇰🇭"), + FLAG_KIRIBATI("🇰🇮"), + FLAG_COMOROS("🇰🇲"), + FLAG_ST__KITTS_NEVIS("🇰🇳"), + FLAG_NORTH_KOREA("🇰🇵"), + FLAG_SOUTH_KOREA("🇰🇷"), + FLAG_KUWAIT("🇰🇼"), + FLAG_CAYMAN_ISLANDS("🇰🇾"), + FLAG_KAZAKHSTAN("🇰🇿"), + FLAG_LAOS("🇱🇦"), + FLAG_LEBANON("🇱🇧"), + FLAG_ST__LUCIA("🇱🇨"), + FLAG_LIECHTENSTEIN("🇱🇮"), + FLAG_SRI_LANKA("🇱🇰"), + FLAG_LIBERIA("🇱🇷"), + FLAG_LESOTHO("🇱🇸"), + FLAG_LITHUANIA("🇱🇹"), + FLAG_LUXEMBOURG("🇱🇺"), + FLAG_LATVIA("🇱🇻"), + FLAG_LIBYA("🇱🇾"), + FLAG_MOROCCO("🇲🇦"), + FLAG_MONACO("🇲🇨"), + FLAG_MOLDOVA("🇲🇩"), + FLAG_MONTENEGRO("🇲🇪"), + FLAG_ST__MARTIN("🇲🇫"), + FLAG_MADAGASCAR("🇲🇬"), + FLAG_MARSHALL_ISLANDS("🇲🇭"), + FLAG_NORTH_MACEDONIA("🇲🇰"), + FLAG_MALI("🇲🇱"), + FLAG_MYANMAR_BURMA("🇲🇲"), + FLAG_MONGOLIA("🇲🇳"), + FLAG_MACAO_SAR_CHINA("🇲🇴"), + FLAG_NORTHERN_MARIANA_ISLANDS("🇲🇵"), + FLAG_MARTINIQUE("🇲🇶"), + FLAG_MAURITANIA("🇲🇷"), + FLAG_MONTSERRAT("🇲🇸"), + FLAG_MALTA("🇲🇹"), + FLAG_MAURITIUS("🇲🇺"), + FLAG_MALDIVES("🇲🇻"), + FLAG_MALAWI("🇲🇼"), + FLAG_MEXICO("🇲🇽"), + FLAG_MALAYSIA("🇲🇾"), + FLAG_MOZAMBIQUE("🇲🇿"), + FLAG_NAMIBIA("🇳🇦"), + FLAG_NEW_CALEDONIA("🇳🇨"), + FLAG_NIGER("🇳🇪"), + FLAG_NORFOLK_ISLAND("🇳🇫"), + FLAG_NIGERIA("🇳🇬"), + FLAG_NICARAGUA("🇳🇮"), + FLAG_NETHERLANDS("🇳🇱"), + FLAG_NORWAY("🇳🇴"), + FLAG_NEPAL("🇳🇵"), + FLAG_NAURU("🇳🇷"), + FLAG_NIUE("🇳🇺"), + FLAG_NEW_ZEALAND("🇳🇿"), + FLAG_OMAN("🇴🇲"), + FLAG_PANAMA("🇵🇦"), + FLAG_PERU("🇵🇪"), + FLAG_FRENCH_POLYNESIA("🇵🇫"), + FLAG_PAPUA_NEW_GUINEA("🇵🇬"), + FLAG_PHILIPPINES("🇵🇭"), + FLAG_PAKISTAN("🇵🇰"), + FLAG_POLAND("🇵🇱"), + FLAG_ST__PIERRE_MIQUELON("🇵🇲"), + FLAG_PITCAIRN_ISLANDS("🇵🇳"), + FLAG_PUERTO_RICO("🇵🇷"), + FLAG_PALESTINIAN_TERRITORIES("🇵🇸"), + FLAG_PORTUGAL("🇵🇹"), + FLAG_PALAU("🇵🇼"), + FLAG_PARAGUAY("🇵🇾"), + FLAG_QATAR("🇶🇦"), + FLAG_REUNION("🇷🇪"), + FLAG_ROMANIA("🇷🇴"), + FLAG_SERBIA("🇷🇸"), + FLAG_RUSSIA("🇷🇺"), + FLAG_RWANDA("🇷🇼"), + FLAG_SAUDI_ARABIA("🇸🇦"), + FLAG_SOLOMON_ISLANDS("🇸🇧"), + FLAG_SEYCHELLES("🇸🇨"), + FLAG_SUDAN("🇸🇩"), + FLAG_SWEDEN("🇸🇪"), + FLAG_SINGAPORE("🇸🇬"), + FLAG_ST__HELENA("🇸🇭"), + FLAG_SLOVENIA("🇸🇮"), + FLAG_SVALBARD_JAN_MAYEN("🇸🇯"), + FLAG_SLOVAKIA("🇸🇰"), + FLAG_SIERRA_LEONE("🇸🇱"), + FLAG_SAN_MARINO("🇸🇲"), + FLAG_SENEGAL("🇸🇳"), + FLAG_SOMALIA("🇸🇴"), + FLAG_SURINAME("🇸🇷"), + FLAG_SOUTH_SUDAN("🇸🇸"), + FLAG_SAO_TOME_PRINCIPE("🇸🇹"), + FLAG_EL_SALVADOR("🇸🇻"), + FLAG_SINT_MAARTEN("🇸🇽"), + FLAG_SYRIA("🇸🇾"), + FLAG_ESWATINI("🇸🇿"), + FLAG_TRISTAN_DA_CUNHA("🇹🇦"), + FLAG_TURKS_CAICOS_ISLANDS("🇹🇨"), + FLAG_CHAD("🇹🇩"), + FLAG_FRENCH_SOUTHERN_TERRITORIES("🇹🇫"), + FLAG_TOGO("🇹🇬"), + FLAG_THAILAND("🇹🇭"), + FLAG_TAJIKISTAN("🇹🇯"), + FLAG_TOKELAU("🇹🇰"), + FLAG_TIMOR_LESTE("🇹🇱"), + FLAG_TURKMENISTAN("🇹🇲"), + FLAG_TUNISIA("🇹🇳"), + FLAG_TONGA("🇹🇴"), + FLAG_TURKEY("🇹🇷"), + FLAG_TRINIDAD_TOBAGO("🇹🇹"), + FLAG_TUVALU("🇹🇻"), + FLAG_TAIWAN("🇹🇼"), + FLAG_TANZANIA("🇹🇿"), + FLAG_UKRAINE("🇺🇦"), + FLAG_UGANDA("🇺🇬"), + FLAG_U_S__OUTLYING_ISLANDS("🇺🇲"), + FLAG_UNITED_NATIONS("🇺🇳"), + FLAG_UNITED_STATES("🇺🇸"), + FLAG_URUGUAY("🇺🇾"), + FLAG_UZBEKISTAN("🇺🇿"), + FLAG_VATICAN_CITY("🇻🇦"), + FLAG_ST__VINCENT_GRENADINES("🇻🇨"), + FLAG_VENEZUELA("🇻🇪"), + FLAG_BRITISH_VIRGIN_ISLANDS("🇻🇬"), + FLAG_U_S__VIRGIN_ISLANDS("🇻🇮"), + FLAG_VIETNAM("🇻🇳"), + FLAG_VANUATU("🇻🇺"), + FLAG_WALLIS_FUTUNA("🇼🇫"), + FLAG_SAMOA("🇼🇸"), + FLAG_KOSOVO("🇽🇰"), + FLAG_YEMEN("🇾🇪"), + FLAG_MAYOTTE("🇾🇹"), + FLAG_SOUTH_AFRICA("🇿🇦"), + FLAG_ZAMBIA("🇿🇲"), + FLAG_ZIMBABWE("🇿🇼"), + FLAG_ENGLAND("🏴󠁧󠁢󠁥󠁮󠁧󠁿"), + FLAG_SCOTLAND("🏴󠁧󠁢󠁳󠁣󠁴󠁿"), + FLAG_WALES("🏴󠁧󠁢󠁷󠁬󠁳󠁿"); + + private final String value; + + Emoji(String value) { + this.value = value; + } + + @Override + public String toString() { + return value; + } +} diff --git a/src/main/java/it/auties/whatsapp/api/ErrorHandler.java b/src/main/java/it/auties/whatsapp/api/ErrorHandler.java new file mode 100644 index 000000000..5c12ca84c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/ErrorHandler.java @@ -0,0 +1,163 @@ +package it.auties.whatsapp.api; + +import it.auties.whatsapp.exception.HmacValidationException; +import it.auties.whatsapp.util.Exceptions; + +import java.nio.file.Path; +import java.util.function.BiConsumer; + +import static it.auties.whatsapp.api.ErrorHandler.Location.*; +import static java.lang.System.Logger.Level.ERROR; +import static java.lang.System.Logger.Level.WARNING; + +/** + * This interface allows to handle a socket error and provides a default way to do so + */ +@SuppressWarnings("unused") +public interface ErrorHandler { + /** + * Handles an error that occurred inside the api + * + * @param whatsapp the caller api + * @param location the location where the error occurred + * @param throwable a stacktrace of the error, if available + * @return a newsletters determining what should be done + */ + Result handleError(Whatsapp whatsapp, Location location, Throwable throwable); + + /** + * Default error handler. Prints the exception on the terminal. + * + * @return a non-null error handler + */ + @SuppressWarnings("CallToPrintStackTrace") + static ErrorHandler toTerminal() { + return defaultErrorHandler((api, error) -> error.printStackTrace()); + } + + /** + * Default error handler. Saves the exception locally. + * The file will be saved in $HOME/.cobalt/errors + * + * @return a non-null error handler + */ + static ErrorHandler toFile() { + return defaultErrorHandler((api, error) -> Exceptions.save(error)); + } + + /** + * Default error handler. Saves the exception locally. + * The file will be saved in {@code directory}. + * + * @param directory the directory where the error should be saved + * @return a non-null error handler + */ + static ErrorHandler toFile(Path directory) { + return defaultErrorHandler((api, error) -> Exceptions.save(directory, error)); + } + + /** + * Default error handler + * + * @param printer a consumer that handles the printing of the throwable, can be null + * @return a non-null error handler + */ + static ErrorHandler defaultErrorHandler(BiConsumer printer) { + return (whatsapp, location, throwable) -> { + var logger = System.getLogger("ErrorHandler"); + logger.log(ERROR, "Socket failure at %s".formatted(location)); + if (printer != null) { + printer.accept(whatsapp, throwable); + } + + if (location == CRYPTOGRAPHY && whatsapp.store().clientType() == ClientType.MOBILE) { + logger.log(WARNING, "Reconnecting"); + return Result.RECONNECT; + } + + if (location == INITIAL_APP_STATE_SYNC + || location == CRYPTOGRAPHY + || (location == MESSAGE && throwable instanceof HmacValidationException)) { + logger.log(WARNING, "Restore"); + return Result.RESTORE; + } + + logger.log(WARNING, "Ignored failure"); + return Result.DISCARD; + }; + } + + /** + * The constants of this enumerated type describe the various locations where an error can occur + * in the socket + */ + enum Location { + /** + * Unknown + */ + UNKNOWN, + /** + * Called when an error is thrown while logging in + */ + LOGIN, + /** + * Cryptographic error + */ + CRYPTOGRAPHY, + /** + * Called when the media connection cannot be renewed + */ + MEDIA_CONNECTION, + /** + * Called when an error arrives from the stream + */ + STREAM, + /** + * Called when an error is thrown while pulling app data + */ + PULL_APP_STATE, + /** + * Called when an error is thrown while pushing app data + */ + PUSH_APP_STATE, + /** + * Called when an error is thrown while pulling initial app data + */ + INITIAL_APP_STATE_SYNC, + /** + * Called when an error occurs when serializing or deserializing a Whatsapp message + */ + MESSAGE, + /** + * Called when syncing messages after first QR scan + */ + HISTORY_SYNC + } + + /** + * The constants of this enumerated type describe the various types of actions that can be + * performed by an error handler in response to a throwable + */ + enum Result { + /** + * Ignores an error that was thrown by the socket + */ + DISCARD, + /** + * Deletes the current session and creates a new one instantly + */ + RESTORE, + /** + * Disconnects from the current session without deleting it + */ + DISCONNECT, + /** + * Disconnects from the current session without deleting it and reconnects to it + */ + RECONNECT, + /** + * Deletes the current session + */ + LOG_OUT + } +} diff --git a/src/main/java/it/auties/whatsapp/api/MobileOptionsBuilder.java b/src/main/java/it/auties/whatsapp/api/MobileOptionsBuilder.java new file mode 100644 index 000000000..5ceb23902 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/MobileOptionsBuilder.java @@ -0,0 +1,136 @@ +package it.auties.whatsapp.api; + +import it.auties.whatsapp.api.MobileRegistrationBuilder.Unregistered; +import it.auties.whatsapp.api.MobileRegistrationBuilder.Unverified; +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.model.business.BusinessCategory; +import it.auties.whatsapp.model.companion.CompanionDevice; + +import java.util.Optional; + +@SuppressWarnings("unused") +public final class MobileOptionsBuilder extends OptionsBuilder { + MobileOptionsBuilder(Store store, Keys keys) { + super(store, keys); + } + + /** + * Set the device to emulate + * + * @return the same instance for chaining + */ + public MobileOptionsBuilder device(CompanionDevice device) { + store.setDevice(device); + return this; + } + + /** + * Sets the business' address + * + * @return the same instance for chaining + */ + public MobileOptionsBuilder businessAddress(String businessAddress) { + store.setBusinessAddress(businessAddress); + return this; + } + + /** + * Sets the business' address longitude + * + * @return the same instance for chaining + */ + public MobileOptionsBuilder businessLongitude(Double businessLongitude) { + store.setBusinessLongitude(businessLongitude); + return this; + } + + /** + * Sets the business' address latitude + * + * @return the same instance for chaining + */ + public MobileOptionsBuilder businessLatitude(Double businessLatitude) { + store.setBusinessLatitude(businessLatitude); + return this; + } + + /** + * Sets the business' description + * + * @return the same instance for chaining + */ + public MobileOptionsBuilder businessDescription(String businessDescription) { + store.setBusinessDescription(businessDescription); + return this; + } + + /** + * Sets the business' website + * + * @return the same instance for chaining + */ + public MobileOptionsBuilder businessWebsite(String businessWebsite) { + store.setBusinessWebsite(businessWebsite); + return this; + } + + /** + * Sets the business' email + * + * @return the same instance for chaining + */ + public MobileOptionsBuilder businessEmail(String businessEmail) { + store.setBusinessEmail(businessEmail); + return this; + } + + /** + * Sets the business' category + * + * @return the same instance for chaining + */ + public MobileOptionsBuilder businessCategory(BusinessCategory businessCategory) { + store.setBusinessCategory(businessCategory); + return this; + } + + /** + * Expects the session to be already registered + * This means that the verification code has already been sent to Whatsapp + * If this is not the case, an exception will be thrown + * + * @return a non-null optional of whatsapp + */ + public Optional registered() { + if (!keys.registered()) { + return Optional.empty(); + } + + return Optional.of(Whatsapp.customBuilder() + .store(store) + .keys(keys) + .errorHandler(errorHandler) + .build()); + } + + /** + * Expects the session to still need verification + * This means that you already have a code, but it hasn't already been sent to Whatsapp + * + * @return a non-null selector + */ + public Unverified unverified() { + return new Unverified(store, keys, errorHandler, null); + } + + /** + * Expects the session to still need registration + * This means that you may or may not have a verification code, but that it hasn't already been sent to Whatsapp + * + * @return a non-null selector + */ + public Unregistered unregistered() { + return new Unregistered(store, keys, errorHandler); + } +} diff --git a/src/main/java/it/auties/whatsapp/api/MobileRegistrationBuilder.java b/src/main/java/it/auties/whatsapp/api/MobileRegistrationBuilder.java new file mode 100644 index 000000000..f5a9813b6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/MobileRegistrationBuilder.java @@ -0,0 +1,201 @@ +package it.auties.whatsapp.api; + +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.model.companion.CompanionDevice; +import it.auties.whatsapp.model.mobile.PhoneNumber; +import it.auties.whatsapp.model.mobile.VerificationCodeMethod; +import it.auties.whatsapp.model.response.RegistrationResponse; +import it.auties.whatsapp.registration.WhatsappRegistration; + +import java.net.URI; +import java.util.Objects; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.function.Supplier; + +/** + * A builder to specify the options for the mobile api + */ +@SuppressWarnings("unused") +public sealed class MobileRegistrationBuilder { + final Store store; + final Keys keys; + final ErrorHandler errorHandler; + RegisteredResult result; + AsyncVerificationCodeSupplier verificationCodeSupplier; + + MobileRegistrationBuilder(Store store, Keys keys, ErrorHandler errorHandler) { + this.store = store; + this.keys = keys; + this.errorHandler = errorHandler; + } + + public final static class Unregistered extends MobileRegistrationBuilder { + private UnverifiedResult unregisteredResult; + private VerificationCodeMethod verificationCodeMethod; + + Unregistered(Store store, Keys keys, ErrorHandler errorHandler) { + super(store, keys, errorHandler); + this.verificationCodeMethod = VerificationCodeMethod.SMS; + } + + public Unregistered verificationCodeSupplier(Supplier verificationCodeSupplier) { + this.verificationCodeSupplier = AsyncVerificationCodeSupplier.of(verificationCodeSupplier); + return this; + } + + public Unregistered verificationCodeSupplier(AsyncVerificationCodeSupplier verificationCodeSupplier) { + this.verificationCodeSupplier = verificationCodeSupplier; + return this; + } + + public Unregistered device(CompanionDevice device) { + store.setDevice(device); + return this; + } + + public Unregistered proxy(URI proxy) { + store.setProxy(proxy); + return this; + } + + public Unregistered verificationCodeMethod(VerificationCodeMethod verificationCodeMethod) { + this.verificationCodeMethod = verificationCodeMethod; + return this; + } + + /** + * Registers a phone number by asking for a verification code and then sending it to Whatsapp + * + * @param phoneNumber a phone number(include the prefix) + * @return a future + */ + public CompletableFuture register(long phoneNumber) { + if (result != null) { + return CompletableFuture.completedFuture(result); + } + + Objects.requireNonNull(verificationCodeSupplier, "Expected a valid verification code supplier"); + Objects.requireNonNull(verificationCodeMethod, "Expected a valid verification method"); + if (!keys.registered()) { + var number = PhoneNumber.of(phoneNumber); + keys.setPhoneNumber(number); + store.setPhoneNumber(number); + var registration = new WhatsappRegistration(store, keys, verificationCodeSupplier, verificationCodeMethod); + return registration.registerPhoneNumber().thenApply(response -> { + var api = Whatsapp.customBuilder() + .store(store) + .keys(keys) + .errorHandler(errorHandler) + .build(); + return this.result = new RegisteredResult(api, Optional.ofNullable(response)); + }); + } + + var api = Whatsapp.customBuilder() + .store(store) + .keys(keys) + .errorHandler(errorHandler) + .build(); + return CompletableFuture.completedFuture(result); + } + + + /** + * Asks Whatsapp for a one-time-password to start the registration process + * + * @param phoneNumber a phone number(include the prefix) + * @return a future + */ + public CompletableFuture requestVerificationCode(long phoneNumber) { + if(unregisteredResult != null) { + return CompletableFuture.completedFuture(unregisteredResult); + } + + var number = PhoneNumber.of(phoneNumber); + keys.setPhoneNumber(number); + store.setPhoneNumber(number); + if (!keys.registered()) { + var registration = new WhatsappRegistration(store, keys, verificationCodeSupplier, verificationCodeMethod); + return registration.requestVerificationCode().thenApply(response -> { + var unverified = new Unverified(store, keys, errorHandler, verificationCodeSupplier); + return this.unregisteredResult = new UnverifiedResult(unverified, Optional.ofNullable(response)); + }); + } + + var unverified = new Unverified(store, keys, errorHandler, verificationCodeSupplier); + return CompletableFuture.completedFuture(this.unregisteredResult = new UnverifiedResult(unverified, Optional.empty())); + } + } + + public final static class Unverified extends MobileRegistrationBuilder { + Unverified(Store store, Keys keys, ErrorHandler errorHandler, AsyncVerificationCodeSupplier verificationCodeSupplier) { + super(store, keys, errorHandler); + this.verificationCodeSupplier = verificationCodeSupplier; + } + + public Unverified verificationCodeSupplier(Supplier verificationCodeSupplier) { + this.verificationCodeSupplier = AsyncVerificationCodeSupplier.of(verificationCodeSupplier); + return this; + } + + public Unverified verificationCodeSupplier(AsyncVerificationCodeSupplier verificationCodeSupplier) { + this.verificationCodeSupplier = verificationCodeSupplier; + return this; + } + + public Unverified device(CompanionDevice device) { + store.setDevice(device); + return this; + } + + public Unverified proxy(URI proxy) { + store.setProxy(proxy); + return this; + } + + /** + * Sends the verification code you already requested to Whatsapp + * + * @return the same instance for chaining + */ + public CompletableFuture verify(long phoneNumber) { + var number = PhoneNumber.of(phoneNumber); + keys.setPhoneNumber(number); + store.setPhoneNumber(number); + return verify(); + } + + /** + * Sends the verification code you already requested to Whatsapp + * + * @return the same instance for chaining + */ + public CompletableFuture verify() { + if(result != null) { + return CompletableFuture.completedFuture(result); + } + + Objects.requireNonNull(store.phoneNumber(), "Missing phone number: please specify it"); + Objects.requireNonNull(verificationCodeSupplier, "Expected a valid verification code supplier"); + var registration = new WhatsappRegistration(store, keys, verificationCodeSupplier, VerificationCodeMethod.NONE); + return registration.sendVerificationCode().thenApply(response -> { + var api = Whatsapp.customBuilder() + .store(store) + .keys(keys) + .errorHandler(errorHandler) + .build(); + return this.result = new RegisteredResult(api, Optional.ofNullable(response)); + }); + } + } + + public record RegisteredResult(Whatsapp whatsapp, Optional response) { + + } + + public record UnverifiedResult(Unverified unverified, Optional response) { + + } +} diff --git a/src/main/java/it/auties/whatsapp/api/OptionsBuilder.java b/src/main/java/it/auties/whatsapp/api/OptionsBuilder.java new file mode 100644 index 000000000..4f10e1cb3 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/OptionsBuilder.java @@ -0,0 +1,113 @@ +package it.auties.whatsapp.api; + +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.listener.RegisterListener; +import it.auties.whatsapp.model.signal.auth.UserAgent.ReleaseChannel; + +import java.net.URI; + +@SuppressWarnings("unused") +public sealed class OptionsBuilder> permits MobileOptionsBuilder, WebOptionsBuilder { + Store store; + Keys keys; + ErrorHandler errorHandler; + + OptionsBuilder(Store store, Keys keys) { + this.store = store; + this.keys = keys; + } + + /** + * Sets the name to provide to Whatsapp during the authentication process + * The web api will display this name in the devices section, while the mobile api will show it to the people you send messages to + * By default, this value will be set to this library's name + * + * @return the same instance for chaining + */ + @SuppressWarnings("unchecked") + public T name(String name) { + store.setName(name); + return (T) this; + } + + /** + * Sets whether listeners marked with the {@link RegisterListener} annotation should be automatically detected and registered + * By default, this option is enabled + * + * @return the same instance for chaining + */ + @SuppressWarnings("unchecked") + public T autodetectListeners(boolean autodetectListeners) { + store.setAutodetectListeners(autodetectListeners); + return (T) this; + } + + /** + * Sets whether a preview should be automatically generated and attached to text messages that contain links + * By default, it's enabled with inference + * + * @return the same instance for chaining + */ + @SuppressWarnings("unchecked") + public T textPreviewSetting(TextPreviewSetting textPreviewSetting) { + store.setTextPreviewSetting(textPreviewSetting); + return (T) this; + } + + /** + * Sets the error handler for this session + * + * @return the same instance for chaining + */ + @SuppressWarnings("unchecked") + public T errorHandler(ErrorHandler errorHandler) { + this.errorHandler = errorHandler; + return (T) this; + } + + /** + * Sets the release channel + * + * @return the same instance for chaining + */ + @SuppressWarnings("unchecked") + public T releaseChannel(ReleaseChannel releaseChannel) { + store.setReleaseChannel(releaseChannel); + return (T) this; + } + + /** + * Sets the proxy to use for the socket + * + * @return the same instance for chaining + */ + @SuppressWarnings("unchecked") + public T proxy(URI proxy) { + store.setProxy(proxy); + return (T) this; + } + + /** + * Whether presence updates should be handled automatically + * + * @return the same instance for chaining + */ + @SuppressWarnings("unchecked") + public T automaticPresenceUpdates(boolean automaticPresenceUpdates) { + store.setAutomaticPresenceUpdates(automaticPresenceUpdates); + return (T) this; + } + + /** + * Sets whether the mac of every app state patch should be validated or not + * By default, it's set to false + * + * @return the same instance for chaining + */ + @SuppressWarnings("unchecked") + public T checkPatchMacks(boolean checkPatchMacs) { + store.setCheckPatchMacs(checkPatchMacs); + return (T) this; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/api/PairingCodeHandler.java b/src/main/java/it/auties/whatsapp/api/PairingCodeHandler.java new file mode 100644 index 000000000..1057e545b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/PairingCodeHandler.java @@ -0,0 +1,24 @@ +package it.auties.whatsapp.api; + +import java.util.function.Consumer; + +/** + * This interface allows to consume a pairing code sent by WhatsappWeb + */ +@FunctionalInterface +@SuppressWarnings("unused") +public non-sealed interface PairingCodeHandler extends Consumer, WebVerificationHandler { + /** + * Prints the pairing code to the terminal + */ + static PairingCodeHandler toTerminal() { + return System.out::println; + } + + /** + * Discards the pairing code + */ + static PairingCodeHandler discarding() { + return ignored -> {}; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/api/QrHandler.java b/src/main/java/it/auties/whatsapp/api/QrHandler.java new file mode 100644 index 000000000..d9ea50562 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/QrHandler.java @@ -0,0 +1,143 @@ +package it.auties.whatsapp.api; + +import com.google.zxing.BarcodeFormat; +import com.google.zxing.EncodeHintType; +import com.google.zxing.MultiFormatWriter; +import com.google.zxing.WriterException; +import com.google.zxing.common.BitMatrix; +import com.google.zxing.qrcode.decoder.ErrorCorrectionLevel; +import it.auties.qr.QrTerminal; + +import java.awt.*; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.Path; +import java.util.Map; +import java.util.function.Consumer; + +import static com.google.zxing.client.j2se.MatrixToImageWriter.writeToPath; +import static java.lang.System.Logger.Level.INFO; +import static java.nio.file.Files.createTempFile; + +/** + * This interface allows to consume a qr code and provides default common implementations to do so + */ +@FunctionalInterface +@SuppressWarnings("unused") +public non-sealed interface QrHandler extends Consumer, WebVerificationHandler { + /** + * Prints the QR code to the terminal. If your terminal doesn't support utf, you may see random + * characters. + */ + static QrHandler toTerminal() { + return toString(System.out::println); + } + + /** + * Transforms the qr code in a UTF-8 string and accepts a consumer for the latter + * + * @param smallQrConsumer the non-null consumer + */ + static QrHandler toString(Consumer smallQrConsumer) { + return qr -> { + var matrix = createMatrix(qr, 10, 0); + smallQrConsumer.accept(QrTerminal.toString(matrix, true)); + }; + } + + /** + * Transforms the qr code in a UTF-8 plain string and accepts a consumer for the latter + * + * @param qrConsumer the non-null consumer + */ + static QrHandler toPlainString(Consumer qrConsumer) { + return qrConsumer::accept; + } + + /** + * Utility method to create a matrix from a qr countryCode + * + * @param qr the non-null source + * @param size the size of the qr countryCode + * @param margin the margin for the qr countryCode + * @return a non-null matrix + */ + static BitMatrix createMatrix(String qr, int size, int margin) { + try { + var writer = new MultiFormatWriter(); + return writer.encode(qr, BarcodeFormat.QR_CODE, size, size, Map.of(EncodeHintType.MARGIN, margin, EncodeHintType.ERROR_CORRECTION, ErrorCorrectionLevel.L)); + } catch (WriterException exception) { + throw new UnsupportedOperationException("Cannot create qr countryCode", exception); + } + } + + /** + * Saves the QR code to a temp file + * + * @param fileConsumer the consumer to digest the created file + */ + static QrHandler toFile(ToFileConsumer fileConsumer) { + try { + var file = createTempFile("qr", ".jpg"); + return toFile(file, fileConsumer); + } catch (IOException exception) { + throw new UncheckedIOException("Cannot create temp file for qr handler", exception); + } + } + + /** + * Saves the QR code to a specified file + * + * @param path the location where the qr will be written + * @param fileConsumer the consumer to digest the created file + */ + static QrHandler toFile(Path path, ToFileConsumer fileConsumer) { + return qr -> { + try { + var matrix = createMatrix(qr, 500, 5); + writeToPath(matrix, "jpg", path); + fileConsumer.accept(path); + } catch (IOException exception) { + throw new UncheckedIOException("Cannot save qr to file", exception); + } + }; + } + + /** + * This interface allows to consume a file created by + * {@link QrHandler#toFile(Path, ToFileConsumer)} easily + */ + interface ToFileConsumer extends Consumer { + /** + * Discard the newly created file + */ + static ToFileConsumer discarding() { + return ignored -> { + }; + } + + /** + * Prints the location of the file on the terminal using the system logger + */ + static ToFileConsumer toTerminal() { + return path -> System.getLogger(QrHandler.class.getName()) + .log(INFO, "Saved qr code at %s".formatted(path)); + } + + /** + * Opens the file if a Desktop environment is available + */ + static ToFileConsumer toDesktop() { + return path -> { + try { + if (!Desktop.isDesktopSupported()) { + return; + } + Desktop.getDesktop().open(path.toFile()); + } catch (IOException exception) { + throw new UncheckedIOException("Cannot open file with desktop", exception); + } + }; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/api/SocketEvent.java b/src/main/java/it/auties/whatsapp/api/SocketEvent.java new file mode 100644 index 000000000..ae43d7115 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/SocketEvent.java @@ -0,0 +1,26 @@ +package it.auties.whatsapp.api; + +/** + * The constants of this enumerated type describe the various types of events regarding a socket + */ +public enum SocketEvent { + /** + * Called when the socket is opened + */ + OPEN, + + /** + * Called when the socket is closed + */ + CLOSE, + + /** + * Called when an unexpected error is thrown, can be used as a safety mechanism + */ + ERROR, + + /** + * Called when a ping is sent + */ + PING +} diff --git a/src/main/java/it/auties/whatsapp/api/TextPreviewSetting.java b/src/main/java/it/auties/whatsapp/api/TextPreviewSetting.java new file mode 100644 index 000000000..b815aff23 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/TextPreviewSetting.java @@ -0,0 +1,37 @@ +package it.auties.whatsapp.api; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; + +/** + * The constants of this enumerated type describe the various types of text preview that can be + * used + */ +public enum TextPreviewSetting implements ProtobufEnum { + /** + * Link previews will be generated. If a message contains an url without a schema(for example + * wikipedia.com), the message will be autocorrected to include it and a preview will be + * generated + */ + ENABLED_WITH_INFERENCE(0), + + /** + * Link previews will be generated. No inference will be used. + */ + ENABLED(1), + + /** + * Link previews will not be generated + */ + DISABLED(2); + + final int index; + + TextPreviewSetting(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } +} diff --git a/src/main/java/it/auties/whatsapp/api/WebHistoryLength.java b/src/main/java/it/auties/whatsapp/api/WebHistoryLength.java new file mode 100644 index 000000000..b18c90e99 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/WebHistoryLength.java @@ -0,0 +1,70 @@ +package it.auties.whatsapp.api; + +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.util.Specification; + +/** + * The constants of this enumerated type describe the various chat history's codeLength that Whatsapp + * can send on the first login attempt + */ +public record WebHistoryLength( + @ProtobufProperty(index = 1, type = ProtobufType.INT32) + int size +) implements ProtobufMessage { + private static final WebHistoryLength ZERO = new WebHistoryLength(0); + private static final WebHistoryLength STANDARD = new WebHistoryLength(Specification.Whatsapp.DEFAULT_HISTORY_SIZE); + private static final WebHistoryLength EXTENDED = new WebHistoryLength(Integer.MAX_VALUE); + + /** + * Discards history + * This will save a lot of system resources, but you won't have access to messages sent before the session creation + */ + public static WebHistoryLength zero() { + return ZERO; + } + + + /** + * This is the default setting for the web client + * This is also the recommended setting + */ + public static WebHistoryLength standard() { + return STANDARD; + } + + /** + * This will contain most of your messages + * Unless you 100% know what you are doing don't use this + * It consumes a lot of system resources + */ + public static WebHistoryLength extended() { + return EXTENDED; + } + + /** + * Custom size + */ + public static WebHistoryLength custom(int size) { + return new WebHistoryLength(size); + } + + /** + * Returns whether this history size counts as zero + * + * @return a boolean + */ + public boolean isZero() { + return size == 0; + } + + /** + * Returns whether this history size counts as extended + * + * @return a boolean + */ + public boolean isExtended() { + return size > Specification.Whatsapp.DEFAULT_HISTORY_SIZE; + } +} diff --git a/src/main/java/it/auties/whatsapp/api/WebOptionsBuilder.java b/src/main/java/it/auties/whatsapp/api/WebOptionsBuilder.java new file mode 100644 index 000000000..7a7f05487 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/WebOptionsBuilder.java @@ -0,0 +1,102 @@ +package it.auties.whatsapp.api; + +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.model.mobile.PhoneNumber; + +import java.util.Optional; + +@SuppressWarnings("unused") +public final class WebOptionsBuilder extends OptionsBuilder { + private Whatsapp whatsapp; + + WebOptionsBuilder(Store store, Keys keys) { + super(store, keys); + } + + /** + * Whether the library should send receipts automatically for messages + * By default disabled + * For the web api, if enabled, the companion won't receive notifications + * + * @return the same instance for chaining + */ + public WebOptionsBuilder automaticMessageReceipts(boolean automaticMessageReceipts) { + store.setAutomaticMessageReceipts(automaticMessageReceipts); + return this; + } + + /** + * Sets how much chat history Whatsapp should send when the QR is first scanned. + * By default, one year + * + * @return the same instance for chaining + */ + public WebOptionsBuilder historyLength(WebHistoryLength historyLength) { + store.setHistoryLength(historyLength); + return this; + } + + /** + * Creates a Whatsapp instance with a qr handler + * + * @param qrHandler the non-null handler to use + * @return a Whatsapp instance + */ + public Whatsapp unregistered(QrHandler qrHandler) { + if (whatsapp == null) { + this.whatsapp = Whatsapp.customBuilder() + .store(store) + .keys(keys) + .errorHandler(errorHandler) + .webVerificationSupport(qrHandler) + .build(); + } + + return whatsapp; + } + + /** + * Creates a Whatsapp instance with an OTP handler + * + * @param phoneNumber the phone number of the user + * @param pairingCodeHandler the non-null handler for the pairing code + * @return a Whatsapp instance + */ + public Whatsapp unregistered(long phoneNumber, PairingCodeHandler pairingCodeHandler) { + if (whatsapp == null) { + store.setPhoneNumber(PhoneNumber.of(phoneNumber)); + this.whatsapp = Whatsapp.customBuilder() + .store(store) + .keys(keys) + .errorHandler(errorHandler) + .webVerificationSupport(pairingCodeHandler) + .build(); + } + + return whatsapp; + } + + /** + * Creates a Whatsapp instance with no handlers + * This method assumes that you have already logged in using a QR code or OTP + * Otherwise, it returns an empty optional. + * + * @return an optional + */ + public Optional registered() { + if (!keys.registered()) { + return Optional.empty(); + } + + if (whatsapp == null) { + this.whatsapp = Whatsapp.customBuilder() + .store(store) + .keys(keys) + .errorHandler(errorHandler) + .build(); + } + + return Optional.of(whatsapp); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/api/WebVerificationHandler.java b/src/main/java/it/auties/whatsapp/api/WebVerificationHandler.java new file mode 100644 index 000000000..91d0a90e9 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/WebVerificationHandler.java @@ -0,0 +1,7 @@ +package it.auties.whatsapp.api; + +/** + * A utility sealed interface to represent methods that can be used to verify a WhatsappWeb Client + */ +public sealed interface WebVerificationHandler permits QrHandler, PairingCodeHandler { +} diff --git a/src/main/java/it/auties/whatsapp/api/Whatsapp.java b/src/main/java/it/auties/whatsapp/api/Whatsapp.java new file mode 100644 index 000000000..16becb886 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/Whatsapp.java @@ -0,0 +1,3773 @@ +package it.auties.whatsapp.api; + +import com.google.zxing.BinaryBitmap; +import com.google.zxing.ChecksumException; +import com.google.zxing.FormatException; +import com.google.zxing.NotFoundException; +import com.google.zxing.client.j2se.BufferedImageLuminanceSource; +import com.google.zxing.common.HybridBinarizer; +import com.google.zxing.qrcode.QRCodeReader; +import it.auties.curve25519.Curve25519; +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.crypto.AesGcm; +import it.auties.whatsapp.crypto.Hkdf; +import it.auties.whatsapp.crypto.Hmac; +import it.auties.whatsapp.crypto.SessionCipher; +import it.auties.whatsapp.listener.*; +import it.auties.whatsapp.listener.processor.RegisterListenerProcessor; +import it.auties.whatsapp.model.action.*; +import it.auties.whatsapp.model.business.*; +import it.auties.whatsapp.model.call.Call; +import it.auties.whatsapp.model.call.CallStatus; +import it.auties.whatsapp.model.chat.*; +import it.auties.whatsapp.model.companion.CompanionLinkResult; +import it.auties.whatsapp.model.contact.Contact; +import it.auties.whatsapp.model.contact.ContactStatus; +import it.auties.whatsapp.model.info.*; +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.AttachmentType; +import it.auties.whatsapp.model.media.MediaFile; +import it.auties.whatsapp.model.message.model.*; +import it.auties.whatsapp.model.message.model.reserved.ExtendedMediaMessage; +import it.auties.whatsapp.model.message.server.ProtocolMessage; +import it.auties.whatsapp.model.message.server.ProtocolMessageBuilder; +import it.auties.whatsapp.model.message.standard.CallMessageBuilder; +import it.auties.whatsapp.model.message.standard.NewsletterAdminInviteMessageBuilder; +import it.auties.whatsapp.model.message.standard.ReactionMessageBuilder; +import it.auties.whatsapp.model.message.standard.TextMessage; +import it.auties.whatsapp.model.newsletter.*; +import it.auties.whatsapp.model.node.Attributes; +import it.auties.whatsapp.model.node.Node; +import it.auties.whatsapp.model.privacy.GdprAccountReport; +import it.auties.whatsapp.model.privacy.PrivacySettingEntry; +import it.auties.whatsapp.model.privacy.PrivacySettingType; +import it.auties.whatsapp.model.privacy.PrivacySettingValue; +import it.auties.whatsapp.model.product.LeaveNewsletterRequest; +import it.auties.whatsapp.model.request.*; +import it.auties.whatsapp.model.request.UpdateNewsletterRequest.UpdatePayload; +import it.auties.whatsapp.model.response.*; +import it.auties.whatsapp.model.setting.LocaleSettings; +import it.auties.whatsapp.model.setting.PushNameSettings; +import it.auties.whatsapp.model.signal.auth.*; +import it.auties.whatsapp.model.signal.keypair.SignalKeyPair; +import it.auties.whatsapp.model.sync.*; +import it.auties.whatsapp.model.sync.PatchRequest.PatchEntry; +import it.auties.whatsapp.model.sync.RecordSync.Operation; +import it.auties.whatsapp.socket.SocketHandler; +import it.auties.whatsapp.socket.SocketState; +import it.auties.whatsapp.util.*; + +import javax.imageio.ImageIO; +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.net.URI; +import java.nio.charset.StandardCharsets; +import java.time.Instant; +import java.time.ZonedDateTime; +import java.time.chrono.ChronoZonedDateTime; +import java.util.*; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ThreadLocalRandom; +import java.util.concurrent.TimeUnit; +import java.util.function.Function; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.stream.Stream; + +import static it.auties.whatsapp.model.contact.ContactStatus.COMPOSING; +import static it.auties.whatsapp.model.contact.ContactStatus.RECORDING; + +/** + * A class used to interface a user to WhatsappWeb's WebSocket + */ +@SuppressWarnings({"unused", "UnusedReturnValue"}) +public class Whatsapp { + // The instances are added and removed when the client connects/disconnects + // This is to make sure that the instances remain in memory only as long as it's needed + private static final Map instances = new ConcurrentHashMap<>(); + + static Optional getInstanceByUuid(UUID uuid) { + return Optional.ofNullable(instances.get(uuid)); + } + + static void removeInstanceByUuid(UUID uuid) { + instances.remove(uuid); + } + + private final SocketHandler socketHandler; + + /** + * Checks if a connection exists + * + * @param uuid the non-null uuid + * @return a boolean + */ + public static boolean isConnected(UUID uuid) { + return SocketHandler.isConnected(uuid); + } + + /** + * Checks if a connection exists + * + * @param phoneNumber the non-null phone number + * @return a boolean + */ + public static boolean isConnected(long phoneNumber) { + return SocketHandler.isConnected(phoneNumber); + } + + /** + * Checks if a connection exists + * + * @param alias the non-null alias + * @return a boolean + */ + public static boolean isConnected(String alias) { + return SocketHandler.isConnected(alias); + } + + protected Whatsapp(Store store, Keys keys, ErrorHandler errorHandler, WebVerificationHandler webVerificationHandler) { + this.socketHandler = new SocketHandler(this, store, keys, errorHandler, webVerificationHandler); + addDisconnectionHandler(store); + registerListenersAutomatically(store); + } + + private static void addDisconnectionHandler(Store store) { + store.addListener((OnDisconnected) (reason) -> { + if (reason != DisconnectReason.RECONNECTING) { + removeInstanceByUuid(store.uuid()); + } + }); + } + + private void registerListenersAutomatically(Store store) { + if (!store.autodetectListeners()) { + return; + } + + try { + var clazz = Class.forName(RegisterListenerProcessor.qualifiedClassName()); + var method = clazz.getMethod(RegisterListenerProcessor.methodName(), Whatsapp.class); + method.invoke(null, this); + }catch (ClassNotFoundException exception) { + // Ignored, this can happen if the compilation environment didn't register the processor + }catch (ReflectiveOperationException exception) { + throw new RuntimeException("Cannot register listeners automatically", exception); + } + } + + /** + * Creates a new web api + * The web api is based around the WhatsappWeb client + * + * @return a web api builder + */ + public static ConnectionBuilder webBuilder() { + return new ConnectionBuilder<>(ClientType.WEB); + } + + /** + * Creates a new mobile api + * The mobile api is based around the Whatsapp App available on IOS and Android + * + * @return a web mobile builder + */ + public static ConnectionBuilder mobileBuilder() { + return new ConnectionBuilder<>(ClientType.MOBILE); + } + + /** + * Creates an advanced builder if you need more customization + * + * @return a custom builder + */ + public static WhatsappCustomBuilder customBuilder() { + return new WhatsappCustomBuilder(); + } + + /** + * Connects to Whatsapp + * + * @return a future + */ + public CompletableFuture connect() { + return socketHandler.connect() + .thenRunAsync(() -> instances.put(store().uuid(), this)) + .thenApply(ignored -> this); + } + + /** + * Waits for this session to be disconnected + */ + public void awaitDisconnection() { + var future = new CompletableFuture(); + addDisconnectedListener((reason) -> { + if(reason == DisconnectReason.DISCONNECTED || reason == DisconnectReason.LOGGED_OUT) { + future.complete(null); + } + }); + future.join(); + } + + /** + * Returns whether the connection is active or not + * + * @return a boolean + */ + public boolean isConnected() { + return socketHandler.state() == SocketState.CONNECTED; + } + + /** + * Returns the keys associated with this session + * + * @return a non-null WhatsappKeys + */ + public Keys keys() { + return socketHandler.keys(); + } + + /** + * Returns the store associated with this session + * + * @return a non-null WhatsappStore + */ + public Store store() { + return socketHandler.store(); + } + + /** + * Disconnects from Whatsapp Web's WebSocket if a previous connection exists + * + * @return a future + */ + public CompletableFuture disconnect() { + return socketHandler.disconnect(DisconnectReason.DISCONNECTED); + } + + /** + * Disconnects and reconnects to Whatsapp Web's WebSocket if a previous connection exists + * + * @return a future + */ + public CompletableFuture reconnect() { + return socketHandler.disconnect(DisconnectReason.RECONNECTING); + } + + /** + * Disconnects from Whatsapp Web's WebSocket and logs out of WhatsappWeb invalidating the previous + * saved credentials. The next time the API is used, the QR code will need to be scanned again. + * + * @return a future + */ + public CompletableFuture logout() { + if (jidOrThrowError() == null) { + return socketHandler.disconnect(DisconnectReason.LOGGED_OUT); + } + + var metadata = Map.of("jid", jidOrThrowError(), "reason", "user_initiated"); + var device = Node.of("remove-companion-device", metadata); + return socketHandler.sendQuery("set", "md", device) + .thenRun(() -> {}); + } + + /** + * Changes a privacy setting in Whatsapp's settings. If the value is + * {@link PrivacySettingValue#CONTACTS_EXCEPT}, the excluded parameter should also be filled or an + * exception will be thrown, otherwise it will be ignored. + * + * @param type the non-null setting to change + * @param value the non-null value to attribute to the setting + * @param excluded the non-null excluded contacts if value is {@link PrivacySettingValue#CONTACTS_EXCEPT} + * @return the same instance wrapped in a completable future + */ + public final CompletableFuture changePrivacySetting(PrivacySettingType type, PrivacySettingValue value, JidProvider... excluded) { + Validate.isTrue(type.isSupported(value), + "Cannot change setting %s to %s: this toggle cannot be used because Whatsapp doesn't support it", value.name(), type.name()); + var attributes = Attributes.of() + .put("name", type.data()) + .put("value", value.data()) + .put("dhash", "none", () -> value == PrivacySettingValue.CONTACTS_EXCEPT) + .toMap(); + var excludedJids = Arrays.stream(excluded).map(JidProvider::toJid).toList(); + var children = value != PrivacySettingValue.CONTACTS_EXCEPT ? null : excludedJids.stream() + .map(entry -> Node.of("user", Map.of("jid", entry, "action", "add"))) + .toList(); + return socketHandler.sendQuery("set", "privacy", Node.of("privacy", Node.of("category", attributes, children))) + .thenRun(() -> onPrivacyFeatureChanged(type, value, excludedJids)); + } + + private void onPrivacyFeatureChanged(PrivacySettingType type, PrivacySettingValue value, List excludedJids) { + var newEntry = new PrivacySettingEntry(type, value, excludedJids); + var oldEntry = store().findPrivacySetting(type); + store().addPrivacySetting(type, newEntry); + socketHandler.onPrivacySettingChanged(oldEntry, newEntry); + } + + /** + * Changes the default ephemeral timer of new chats. + * + * @param timer the new ephemeral timer + * @return the same instance wrapped in a completable future + */ + public CompletableFuture changeNewChatsEphemeralTimer(ChatEphemeralTimer timer) { + return socketHandler.sendQuery("set", "disappearing_mode", Node.of("disappearing_mode", Map.of("duration", timer.period().toSeconds()))) + .thenRun(() -> store().setNewChatsEphemeralTimer(timer)); + } + + /** + * Creates a new request to get a document containing all the data that was collected by Whatsapp + * about this user. It takes three business days to receive it. To query the newsletters status, use + * {@link Whatsapp#getGdprAccountInfoStatus()} + * + * @return the same instance wrapped in a completable future + */ + public CompletableFuture createGdprAccountInfo() { + return socketHandler.sendQuery("get", "urn:xmpp:whatsapp:account", Node.of("gdpr", Map.of("gdpr", "request"))) + .thenRun(() -> {}); + } + + /** + * Queries the document containing all the data that was collected by Whatsapp about this user. To + * create a request for this document, use {@link Whatsapp#createGdprAccountInfo()} + * + * @return the same instance wrapped in a completable future + */ + // TODO: Implement ready and error states + public CompletableFuture getGdprAccountInfoStatus() { + return socketHandler.sendQuery("get", "urn:xmpp:whatsapp:account", Node.of("gdpr", Map.of("gdpr", "status"))) + .thenApplyAsync(result -> GdprAccountReport.ofPending(result.attributes().getLong("timestamp"))); + } + + /** + * Changes the name of this user + * + * @param newName the non-null new name + * @return the same instance wrapped in a completable future + */ + public CompletableFuture changeName(String newName) { + var oldName = store().name(); + return socketHandler.send(Node.of("presence", Map.of("name", newName))) + .thenRun(() -> socketHandler.updateUserName(newName, oldName)); + } + + /** + * Changes the about of this user + * + * @param newAbout the non-null new status + * @return the same instance wrapped in a completable future + */ + public CompletableFuture changeAbout(String newAbout) { + return socketHandler.changeAbout(newAbout); + } + + /** + * Sends a request to Whatsapp in order to receive updates when the status of a contact changes. + * These changes include the last known presence and the seconds the contact was last seen. + * + * @param jid the contact whose status the api should receive updates on + * @return a CompletableFuture + */ + public CompletableFuture subscribeToPresence(JidProvider jid) { + return socketHandler.subscribeToPresence(jid); + } + + /** + * Remove a reaction from a message + * + * @param message the non-null message + * @return a CompletableFuture + */ + public CompletableFuture removeReaction(MessageInfo message) { + return sendReaction(message, (String) null); + } + + /** + * Send a reaction to a message + * + * @param message the non-null message + * @param reaction the reaction to send, null if you want to remove the reaction + * @return a CompletableFuture + */ + public CompletableFuture sendReaction(MessageInfo message, Emoji reaction) { + return sendReaction(message, Objects.toString(reaction)); + } + + /** + * Send a reaction to a message + * + * @param message the non-null message + * @param reaction the reaction to send, null if you want to remove the reaction. If a string that + * isn't an emoji supported by Whatsapp is used, it will not get displayed + * correctly. Use {@link Whatsapp#sendReaction(MessageInfo, Emoji)} if + * you need a typed emoji enum. + * @return a CompletableFuture + */ + public CompletableFuture sendReaction(MessageInfo message, String reaction) { + var key = new ChatMessageKeyBuilder() + .id(ChatMessageKey.randomId()) + .chatJid(message.parentJid()) + .senderJid(message.senderJid()) + .fromMe(Objects.equals(message.senderJid().toSimpleJid(), jidOrThrowError().toSimpleJid())) + .id(message.id()) + .build(); + var reactionMessage = new ReactionMessageBuilder() + .key(key) + .content(reaction) + .timestampSeconds(Instant.now().toEpochMilli()) + .build(); + return sendChatMessage(message.parentJid(), MessageContainer.of(reactionMessage), false); + } + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendMessage(JidProvider chat, String message) { + return sendMessage(chat, MessageContainer.of(message)); + } + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendChatMessage(JidProvider chat, String message) { + return sendChatMessage(chat, MessageContainer.of(message)); + } + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendsNewsletterMessage(JidProvider chat, String message) { + return sendNewsletterMessage(chat, MessageContainer.of(message)); + } + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @param quotedMessage the message to quote + * @return a CompletableFuture + */ + public CompletableFuture sendMessage(JidProvider chat, String message, MessageInfo quotedMessage) { + return sendMessage(chat, TextMessage.of(message), quotedMessage); + } + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @param quotedMessage the message to quote + * @return a CompletableFuture + */ + public CompletableFuture sendChatMessage(JidProvider chat, String message, MessageInfo quotedMessage) { + return sendChatMessage(chat, TextMessage.of(message), quotedMessage); + } + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @param quotedMessage the message to quote + * @return a CompletableFuture + */ + public CompletableFuture sendNewsletterMessage(JidProvider chat, String message, MessageInfo quotedMessage) { + return sendNewsletterMessage(chat, TextMessage.of(message), quotedMessage); + } + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @param quotedMessage the message to quote + * @return a CompletableFuture + */ + public CompletableFuture sendMessage(JidProvider chat, ContextualMessage message, MessageInfo quotedMessage) { + var contextInfo = ContextInfo.of(quotedMessage); + message.setContextInfo(contextInfo); + return sendMessage(chat, MessageContainer.of(message)); + } + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @param quotedMessage the message to quote + * @return a CompletableFuture + */ + public CompletableFuture sendChatMessage(JidProvider chat, ContextualMessage message, MessageInfo quotedMessage) { + var contextInfo = ContextInfo.of(quotedMessage); + message.setContextInfo(contextInfo); + return sendChatMessage(chat, MessageContainer.of(message)); + } + + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @param quotedMessage the message to quote + * @return a CompletableFuture + */ + public CompletableFuture sendNewsletterMessage(JidProvider chat, ContextualMessage message, MessageInfo quotedMessage) { + var contextInfo = ContextInfo.of(quotedMessage); + message.setContextInfo(contextInfo); + return sendNewsletterMessage(chat, MessageContainer.of(message)); + } + + + /** + * Builds and sends a message from a chat and a message + * + * @param chat the chat where the message should be sent + * @param message the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendMessage(JidProvider chat, Message message) { + return sendMessage(chat, MessageContainer.of(message)); + } + + /** + * Builds and sends a message from a recipient and a message + * + * @param recipient the recipient where the message should be sent + * @param message the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendMessage(JidProvider recipient, MessageContainer message) { + return recipient.toJid().server() == JidServer.NEWSLETTER ? sendNewsletterMessage(recipient, message) : sendChatMessage(recipient, message); + } + + /** + * Builds and sends a message from a recipient and a message + * + * @param recipient the recipient where the message should be sent + * @param message the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendChatMessage(JidProvider recipient, MessageContainer message) { + return sendChatMessage(recipient, message, message.content().type() == MessageType.TEXT); + } + + public CompletableFuture sendChatMessage(JidProvider recipient, MessageContainer message, boolean compose) { + Validate.isTrue(!recipient.toJid().hasServer(JidServer.NEWSLETTER), "Use sendNewsletterMessage to send a message in a newsletter"); + var timestamp = Clock.nowSeconds(); + var deviceInfo = new DeviceContextInfoBuilder() + .deviceListMetadataVersion(2) + .build(); + var key = new ChatMessageKeyBuilder() + .id(ChatMessageKey.randomId()) + .chatJid(recipient.toJid()) + .fromMe(true) + .senderJid(jidOrThrowError()) + .build(); + var info = new ChatMessageInfoBuilder() + .status(MessageStatus.PENDING) + .senderJid(jidOrThrowError()) + .key(key) + .message(message.withDeviceInfo(deviceInfo)) + .timestampSeconds(timestamp) + .broadcast(recipient.toJid().hasServer(JidServer.BROADCAST)) + .build(); + return sendMessage(info); + } + + /** + * Builds and sends a message from a recipient and a message + * + * @param recipient the recipient where the message should be sent + * @param message the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendNewsletterMessage(JidProvider recipient, MessageContainer message) { + var newsletter = store().findNewsletterByJid(recipient); + Validate.isTrue(newsletter.isPresent(), "Cannot send a message in a newsletter that you didn't join"); + var oldServerId = newsletter.get() + .newestMessage() + .map(NewsletterMessageInfo::serverId) + .orElse(0); + var info = new NewsletterMessageInfo( + ChatMessageKey.randomId(), + oldServerId + 1, + Clock.nowSeconds(), + null, + new ConcurrentHashMap<>(), + message, + MessageStatus.PENDING + ); + info.setNewsletter(newsletter.get()); + return sendMessage(info); + } + + /** + * Builds and sends an edited message + * + * @param oldMessage the message to edit + * @param newMessage the new message's content + * @return a CompletableFuture + */ + public CompletableFuture editMessage(T oldMessage, Message newMessage) { + var oldMessageType = oldMessage.message().content().type(); + var newMessageType = newMessage.type(); + Validate.isTrue(oldMessageType == newMessageType, + "Message type mismatch: %s != %s", + oldMessageType, newMessageType); + return switch (oldMessage) { + case NewsletterMessageInfo oldNewsletterInfo -> { + var info = new NewsletterMessageInfo( + oldNewsletterInfo.id(), + oldNewsletterInfo.serverId(), + Clock.nowSeconds(), + null, + new ConcurrentHashMap<>(), + MessageContainer.ofEditedMessage(newMessage), + MessageStatus.PENDING + ); + info.setNewsletter(oldNewsletterInfo.newsletter()); + var request = new MessageSendRequest.Newsletter(info, Map.of("edit", getEditBit(info))); + yield socketHandler.sendMessage(request) + .thenApply(ignored -> oldMessage); + } + case ChatMessageInfo oldChatInfo -> { + var key = new ChatMessageKeyBuilder() + .id(oldChatInfo.id()) + .chatJid(oldChatInfo.chatJid()) + .fromMe(true) + .senderJid(jidOrThrowError()) + .build(); + var info = new ChatMessageInfoBuilder() + .status(MessageStatus.PENDING) + .senderJid(jidOrThrowError()) + .key(key) + .message(MessageContainer.ofEditedMessage(newMessage)) + .timestampSeconds(Clock.nowSeconds()) + .broadcast(oldChatInfo.chatJid().hasServer(JidServer.BROADCAST)) + .build(); + var request = new MessageSendRequest.Chat(info, null, false, false, Map.of("edit", getEditBit(info))); + yield socketHandler.sendMessage(request) + .thenApply(ignored -> oldMessage); + } + default -> throw new IllegalStateException("Unsupported edit: " + oldMessage); + }; + } + + public CompletableFuture sendStatus(String message) { + return sendStatus(MessageContainer.of(message)); + } + + public CompletableFuture sendStatus(Message message) { + return sendStatus(MessageContainer.of(message)); + } + + public CompletableFuture sendStatus(MessageContainer message) { + var timestamp = Clock.nowSeconds(); + var deviceInfo = new DeviceContextInfoBuilder() + .deviceListMetadataVersion(2) + .build(); + var key = new ChatMessageKeyBuilder() + .id(ChatMessageKey.randomId()) + .chatJid(Jid.of("status@broadcast")) + .fromMe(true) + .senderJid(jidOrThrowError()) + .build(); + var info = new ChatMessageInfoBuilder() + .status(MessageStatus.PENDING) + .senderJid(jidOrThrowError()) + .key(key) + .message(message.withDeviceInfo(deviceInfo)) + .timestampSeconds(timestamp) + .broadcast(false) + .build(); + return sendMessage(info); + } + + /** + * Sends a message to a chat + * + * @param info the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendMessage(ChatMessageInfo info) { + if(store().clientType() == ClientType.MOBILE) { + throw new IllegalStateException("The mobile API cannot send messages or the account will be banned, if you need to send messages please contact me on Telegram @Auties00"); + } + + return socketHandler.sendMessage(new MessageSendRequest.Chat(info)) + .thenApply(ignored -> info); + } + + /** + * Sends a message to a newsletter + * + * @param info the message to send + * @return a CompletableFuture + */ + public CompletableFuture sendMessage(NewsletterMessageInfo info) { + if(store().clientType() == ClientType.MOBILE) { + throw new IllegalStateException("The mobile API cannot send messages or the account will be banned, if you need to send messages please contact me on Telegram @Auties00"); + } + + return socketHandler.sendMessage(new MessageSendRequest.Newsletter(info)) + .thenApply(ignored -> info); + } + + /** + * Marks a chat as read. + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture markChatRead(JidProvider chat) { + return mark(chat, true) + .thenComposeAsync(ignored -> markAllAsRead(chat)); + } + + private CompletableFuture markAllAsRead(JidProvider chat) { + var all = store() + .findChatByJid(chat.toJid()) + .stream() + .map(Chat::unreadMessages) + .flatMap(Collection::stream) + .map(this::markMessageRead) + .toArray(CompletableFuture[]::new); + return CompletableFuture.allOf(all); + } + + /** + * Marks a chat as unread + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture markChatUnread(JidProvider chat) { + return mark(chat, false); + } + + private CompletableFuture mark(JidProvider chat, boolean read) { + if (store().clientType() == ClientType.MOBILE) { + // TODO: Send notification to companions + store().findChatByJid(chat.toJid()) + .ifPresent(entry -> entry.setMarkedAsUnread(read)); + return CompletableFuture.completedFuture(null); + } + + var range = createRange(chat, false); + var markAction = new MarkChatAsReadAction(read, Optional.of(range)); + var syncAction = ActionValueSync.of(markAction); + var entry = PatchEntry.of(syncAction, Operation.SET, chat.toJid().toString()); + var request = new PatchRequest(PatchType.REGULAR_HIGH, List.of(entry)); + return socketHandler.pushPatch(request); + } + + private ActionMessageRangeSync createRange(JidProvider chat, boolean allMessages) { + var known = store().findChatByJid(chat.toJid()).orElseGet(() -> store().addNewChat(chat.toJid())); + return new ActionMessageRangeSync(known, allMessages); + } + + /** + * Marks a message as read + * + * @param info the target message + * @return a CompletableFuture + */ + public CompletableFuture markMessageRead(ChatMessageInfo info) { + var type = store().findPrivacySetting(PrivacySettingType.READ_RECEIPTS) + .value() == PrivacySettingValue.EVERYONE ? "read" : "read-self"; + socketHandler.sendReceipt(info.chatJid(), info.senderJid(), List.of(info.id()), type); + info.chat().ifPresent(chat -> { + var count = chat.unreadMessagesCount(); + if (count > 0) { + chat.setUnreadMessagesCount(count - 1); + } + }); + info.setStatus(MessageStatus.READ); + return CompletableFuture.completedFuture(info); + } + + /** + * Awaits for a single newsletters to a message + * + * @param info the non-null message whose newsletters is pending + * @return a non-null newsletters + */ + public CompletableFuture awaitMessageReply(ChatMessageInfo info) { + return awaitMessageReply(info.id()); + } + + /** + * Awaits for a single newsletters to a message + * + * @param id the non-null id of message whose newsletters is pending + * @return a non-null newsletters + */ + public CompletableFuture awaitMessageReply(String id) { + return store().addPendingReply(id); + } + + /** + * Executes a query to determine whether a user has an account on Whatsapp + * + * @param contact the contact to check + * @return a CompletableFuture that wraps a non-null newsletters + */ + public CompletableFuture hasWhatsapp(JidProvider contact) { + return hasWhatsapp(new JidProvider[]{contact}).thenApply(result -> result.get(contact.toJid())); + } + + /** + * Executes a query to determine whether any number of users have an account on Whatsapp + * + * @param contacts the contacts to check + * @return a CompletableFuture that wraps a non-null map + */ + public CompletableFuture> hasWhatsapp(JidProvider... contacts) { + var jids = Arrays.stream(contacts) + .map(JidProvider::toJid) + .toList(); + var contactNodes = jids.stream() + .map(jid -> Node.of("user", Node.of("contact", jid.toPhoneNumber()))) + .toList(); + return socketHandler.sendInteractiveQuery(List.of(Node.of("contact")), contactNodes, List.of()) + .thenApplyAsync(result -> parseHasWhatsappResponse(jids, result)); + } + + private Map parseHasWhatsappResponse(List contacts, List nodes) { + var result = nodes.stream() + .map(this::parseHasWhatsappResponse) + .collect(Collectors.toMap(HasWhatsappResponse::contact, Function.identity(), (first, second) -> first, HashMap::new)); + contacts.stream() + .filter(contact -> !result.containsKey(contact)) + .forEach(contact -> result.put(contact, new HasWhatsappResponse(contact, false))); + return Collections.unmodifiableMap(result); + } + + private HasWhatsappResponse parseHasWhatsappResponse(Node node) { + var jid = node.attributes() + .getRequiredJid("jid"); + var in = node.findNode("contact") + .orElseThrow(() -> new NoSuchElementException("Missing contact in HasWhatsappResponse")) + .attributes() + .getRequiredString("type") + .equals("in"); + return new HasWhatsappResponse(jid, in); + } + + /** + * Queries the block list + * + * @return a CompletableFuture + */ + public CompletableFuture> queryBlockList() { + return socketHandler.queryBlockList(); + } + + /** + * Queries the display name of a contact + * + * @param contactJid the non-null contact + * @return a CompletableFuture + */ + public CompletableFuture> queryName(JidProvider contactJid) { + var contact = store().findContactByJid(contactJid); + return contact.map(value -> CompletableFuture.completedFuture(value.chosenName())) + .orElseGet(() -> queryNameFromServer(contactJid)); + } + + private CompletableFuture> queryNameFromServer(JidProvider contactJid) { + var query = new UserChosenNameRequest(List.of(new UserChosenNameRequest.Variable(contactJid.toJid().user()))); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "6556393721124826"), Json.writeValueAsBytes(query))) + .thenApplyAsync(this::parseNameResponse); + } + + private Optional parseNameResponse(Node result) { + return result.findNode("result") + .flatMap(Node::contentAsString) + .flatMap(UserChosenNameResponse::ofJson) + .flatMap(UserChosenNameResponse::name); + } + + /** + * Queries the written whatsapp status of a Contact + * + * @param chat the target contact + * @return a CompletableFuture that wraps an optional contact status newsletters + */ + public CompletableFuture> queryAbout(JidProvider chat) { + return socketHandler.queryAbout(chat); + } + + /** + * Queries the profile picture + * + * @param chat the chat of the chat to query + * @return a CompletableFuture that wraps nullable jpg url hosted on Whatsapp's servers + */ + public CompletableFuture> queryPicture(JidProvider chat) { + return socketHandler.queryPicture(chat); + } + + /** + * Queries the metadata of a group + * + * @param chat the target group + * @return a CompletableFuture + */ + public CompletableFuture queryGroupMetadata(JidProvider chat) { + return socketHandler.queryGroupMetadata(chat.toJid()); + } + + /** + * Queries a business profile, if available + * + * @param contact the target contact + * @return a CompletableFuture + */ + public CompletableFuture> queryBusinessProfile(JidProvider contact) { + return socketHandler.sendQuery("get", "w:biz", Node.of("business_profile", Map.of("v", 116), + Node.of("profile", Map.of("jid", contact.toJid())))) + .thenApplyAsync(this::getBusinessProfile); + } + + private Optional getBusinessProfile(Node result) { + return result.findNode("business_profile") + .flatMap(entry -> entry.findNode("profile")) + .map(BusinessProfile::of); + } + + /** + * Queries all the known business categories + * + * @return a CompletableFuture + */ + public CompletableFuture> queryBusinessCategories() { + return socketHandler.queryBusinessCategories(); + } + + /** + * Queries the invite code of a group + * + * @param chat the target group + * @return a CompletableFuture + */ + public CompletableFuture queryGroupInviteCode(JidProvider chat) { + return socketHandler.sendQuery(chat.toJid(), "get", "w:g2", Node.of("invite")) + .thenApplyAsync(this::parseInviteCode); + } + + private String parseInviteCode(Node result) { + return result.findNode("invite") + .orElseThrow(() -> new NoSuchElementException("Missing invite code in invite newsletters")) + .attributes() + .getRequiredString("code"); + } + + /** + * Revokes the invite code of a group + * + * @param chat the target group + * @return a CompletableFuture + */ + public CompletableFuture revokeGroupInvite(JidProvider chat) { + return socketHandler.sendQuery(chat.toJid(), "set", "w:g2", Node.of("invite")) + .thenRun(() -> {}); + } + + /** + * Accepts the invite for a group + * + * @param inviteCode the invite countryCode + * @return a CompletableFuture + */ + public CompletableFuture> acceptGroupInvite(String inviteCode) { + return socketHandler.sendQuery(JidServer.GROUP.toJid(), "set", "w:g2", Node.of("invite", Map.of("code", inviteCode))) + .thenApplyAsync(this::parseAcceptInvite); + } + + private Optional parseAcceptInvite(Node result) { + return result.findNode("group") + .flatMap(group -> group.attributes().getOptionalJid("jid")) + .map(jid -> store().findChatByJid(jid).orElseGet(() -> store().addNewChat(jid))); + } + + /** + * Changes your presence for everyone on Whatsapp + * + * @param available whether you are online or not + * @return a CompletableFuture + */ + public CompletableFuture changePresence(boolean available) { + var status = socketHandler.store().online(); + if (status == available) { + return CompletableFuture.completedFuture(status); + } + + var presence = available ? ContactStatus.AVAILABLE : ContactStatus.UNAVAILABLE; + var node = Node.of("presence", Map.of("name", store().name(), "type", presence.toString())); + return socketHandler.sendWithNoResponse(node) + .thenAcceptAsync(socketHandler -> updateSelfPresence(null, presence)) + .thenApplyAsync(ignored -> available); + } + + private void updateSelfPresence(JidProvider chatJid, ContactStatus presence) { + if (chatJid == null) { + store().setOnline(presence == ContactStatus.AVAILABLE); + } + + var self = store().findContactByJid(jidOrThrowError().toSimpleJid()); + if (self.isEmpty()) { + return; + } + + if (presence == ContactStatus.AVAILABLE || presence == ContactStatus.UNAVAILABLE) { + self.get().setLastKnownPresence(presence); + } + if (chatJid != null) { + store().findChatByJid(chatJid).ifPresent(chat -> chat.presences().put(self.get().jid(), presence)); + } + self.get().setLastSeen(ZonedDateTime.now()); + } + + /** + * Changes your presence for a specific chat + * + * @param chatJid the target chat + * @param presence the new status + * @return a CompletableFuture + */ + public CompletableFuture changePresence(JidProvider chatJid, ContactStatus presence) { + var knownPresence = store().findChatByJid(chatJid) + .map(Chat::presences) + .map(entry -> entry.get(jidOrThrowError().toSimpleJid())) + .orElse(null); + if (knownPresence == COMPOSING || knownPresence == RECORDING) { + var node = Node.of("chatstate", Map.of("to", chatJid.toJid()), Node.of("paused")); + return socketHandler.sendWithNoResponse(node); + } + + if (presence == COMPOSING || presence == RECORDING) { + var tag = presence == RECORDING ? COMPOSING : presence; + var node = Node.of("chatstate", + Map.of("to", chatJid.toJid()), + Node.of(COMPOSING.toString(), presence == RECORDING ? Map.of("media", "audio") : Map.of())); + return socketHandler.sendWithNoResponse(node) + .thenAcceptAsync(socketHandler -> updateSelfPresence(chatJid, presence)); + } + + var node = Node.of("presence", Map.of("type", presence.toString(), "name", store().name())); + return socketHandler.sendWithNoResponse(node) + .thenAcceptAsync(socketHandler -> updateSelfPresence(chatJid, presence)); + } + + /** + * Promotes any number of contacts to admin in a group + * + * @param group the target group + * @param contacts the target contacts + * @return a CompletableFuture + */ + public CompletableFuture> promoteGroupParticipant(JidProvider group, JidProvider... contacts) { + return executeActionOnGroupParticipant(group, GroupAction.PROMOTE, contacts); + } + + /** + * Demotes any number of contacts to admin in a group + * + * @param group the target group + * @param contacts the target contacts + * @return a CompletableFuture + */ + public CompletableFuture> demoteGroupParticipant(JidProvider group, JidProvider... contacts) { + return executeActionOnGroupParticipant(group, GroupAction.DEMOTE, contacts); + } + + /** + * Adds any number of contacts to a group + * + * @param group the target group + * @param contacts the target contact/s + * @return a CompletableFuture + */ + public CompletableFuture> addGroupParticipant(JidProvider group, JidProvider... contacts) { + return executeActionOnGroupParticipant(group, GroupAction.ADD, contacts); + } + + /** + * Removes any number of contacts from group + * + * @param group the target group + * @param contacts the target contact/s + * @return a CompletableFuture + */ + public CompletableFuture> removeGroupParticipant(JidProvider group, JidProvider... contacts) { + return executeActionOnGroupParticipant(group, GroupAction.REMOVE, contacts); + } + + private CompletableFuture> executeActionOnGroupParticipant(JidProvider group, GroupAction action, JidProvider... jids) { + var body = Arrays.stream(jids) + .map(JidProvider::toJid) + .map(jid -> Node.of("participant", Map.of("jid", checkGroupParticipantJid(jid, "Cannot execute action on yourself")))) + .map(innerBody -> Node.of(action.data(), innerBody)) + .toArray(Node[]::new); + return socketHandler.sendQuery(group.toJid(), "set", "w:g2", body) + .thenApplyAsync(result -> parseGroupActionResponse(result, group, action)); + } + + private Jid checkGroupParticipantJid(Jid jid, String errorMessage) { + Validate.isTrue(!Objects.equals(jid.toSimpleJid(), jidOrThrowError().toSimpleJid()), errorMessage); + return jid; + } + + private List parseGroupActionResponse(Node result, JidProvider groupJid, GroupAction action) { + var results = result.findNode(action.data()) + .orElseThrow(() -> new NoSuchElementException("An erroneous group operation was executed")) + .findNodes("participant") + .stream() + .filter(participant -> !participant.attributes().hasKey("error")) + .map(participant -> participant.attributes().getOptionalJid("jid")) + .flatMap(Optional::stream) + .toList(); + var chat = groupJid instanceof Chat entry ? entry : store() + .findChatByJid(groupJid) + .orElse(null); + if (chat != null) { + results.forEach(entry -> handleGroupAction(action, chat, entry)); + } + + return results; + } + + private void handleGroupAction(GroupAction action, Chat chat, Jid entry) { + switch (action) { + case ADD -> chat.addParticipant(entry, GroupRole.USER); + case REMOVE -> { + chat.removeParticipant(entry); + chat.addPastParticipant(new GroupPastParticipant(entry, GroupPastParticipant.Reason.REMOVED, Clock.nowSeconds())); + } + case PROMOTE -> chat.findParticipant(entry) + .ifPresent(participant -> participant.setRole(GroupRole.ADMIN)); + case DEMOTE -> chat.findParticipant(entry) + .ifPresent(participant -> participant.setRole(GroupRole.USER)); + } + } + + /** + * Changes the name of a group + * + * @param group the target group + * @param newName the new name for the group + * @return a CompletableFuture + * @throws IllegalArgumentException if the provided new name is empty or blank + */ + public CompletableFuture changeGroupSubject(JidProvider group, String newName) { + var body = Node.of("subject", newName.getBytes(StandardCharsets.UTF_8)); + return socketHandler.sendQuery(group.toJid(), "set", "w:g2", body) + .thenRun(() -> {}); + } + + /** + * Changes the description of a group + * + * @param group the target group + * @param description the new name for the group, can be null if you want to remove it + * @return a CompletableFuture + */ + public CompletableFuture changeGroupDescription(JidProvider group, String description) { + return socketHandler.queryGroupMetadata(group.toJid()) + .thenApplyAsync(GroupMetadata::descriptionId) + .thenComposeAsync(descriptionId -> changeGroupDescription(group, description, descriptionId.orElse(null))) + .thenRun(() -> {}); + } + + private CompletableFuture changeGroupDescription(JidProvider group, String description, String descriptionId) { + var descriptionNode = Optional.ofNullable(description) + .map(content -> Node.of("body", content.getBytes(StandardCharsets.UTF_8))) + .orElse(null); + var attributes = Attributes.of() + .put("id", ChatMessageKey.randomId(), () -> description != null) + .put("delete", true, () -> description == null) + .put("prev", descriptionId, () -> descriptionId != null) + .toMap(); + var body = Node.of("description", attributes, descriptionNode); + return socketHandler.sendQuery(group.toJid(), "set", "w:g2", body) + .thenRun(() -> onDescriptionSet(group, description)); + } + + private void onDescriptionSet(JidProvider groupJid, String description) { + if (groupJid instanceof Chat chat) { + chat.setDescription(description); + return; + } + + var group = store().findChatByJid(groupJid); + group.ifPresent(chat -> chat.setDescription(description)); + } + + /** + * Changes a group setting + * + * @param group the non-null group affected by this change + * @param setting the non-null setting + * @param policy the non-null policy + * @return a future + */ + public CompletableFuture changeGroupSetting(JidProvider group, GroupSetting setting, ChatSettingPolicy policy) { + Validate.isTrue(group.toJid().hasServer(JidServer.GROUP), "This method only accepts groups"); + var body = switch (setting) { + case EDIT_GROUP_INFO -> Node.of(policy == ChatSettingPolicy.ADMINS ? "locked" : "unlocked"); + case SEND_MESSAGES -> Node.of(policy == ChatSettingPolicy.ADMINS ? "announcement" : "not_announcement"); + case ADD_PARTICIPANTS -> + Node.of("member_add_mode", policy == ChatSettingPolicy.ADMINS ? "admin_add".getBytes(StandardCharsets.UTF_8) : "all_member_add".getBytes(StandardCharsets.UTF_8)); + case APPROVE_PARTICIPANTS -> + Node.of("membership_approval_mode", Node.of("group_join", Map.of("state", policy == ChatSettingPolicy.ADMINS ? "on" : "off"))); + }; + return socketHandler.sendQuery(group.toJid(), "set", "w:g2", body) + .thenRun(() -> {}); + } + + /** + * Changes the profile picture of yourself + * + * @param image the new image, can be null if you want to remove it + * @return a CompletableFuture + */ + public CompletableFuture changeProfilePicture(byte[] image) { + return changeGroupPicture(jidOrThrowError(), image); + } + + /** + * Changes the picture of a group + * + * @param group the target group + * @param image the new image, can be null if you want to remove it + * @return a CompletableFuture + */ + public CompletableFuture changeGroupPicture(JidProvider group, URI image) { + var imageFuture = image == null ? CompletableFuture.completedFuture((byte[]) null) : Medias.downloadAsync(image); + return imageFuture.thenComposeAsync(imageResult -> changeGroupPicture(group, imageResult)); + } + + /** + * Changes the picture of a group + * + * @param group the target group + * @param image the new image, can be null if you want to remove it + * @return a CompletableFuture + */ + public CompletableFuture changeGroupPicture(JidProvider group, byte[] image) { + var profilePic = image != null ? Medias.getProfilePic(image) : null; + var body = Node.of("picture", Map.of("type", "image"), profilePic); + return socketHandler.sendQuery(group.toJid().toSimpleJid(), "set", "w:profile:picture", body) + .thenRun(() -> {}); + } + + /** + * Creates a new group + * + * @param subject the new group's name + * @param contacts at least one contact to add to the group + * @return a CompletableFuture + */ + public CompletableFuture> createGroup(String subject, JidProvider... contacts) { + return createGroup(subject, ChatEphemeralTimer.OFF, contacts); + } + + /** + * Creates a new group + * + * @param subject the new group's name + * @param timer the default ephemeral timer for messages sent in this group + * @param contacts at least one contact to add to the group + * @return a CompletableFuture + */ + public CompletableFuture> createGroup(String subject, ChatEphemeralTimer timer, JidProvider... contacts) { + return createGroup(subject, timer, null, contacts); + } + + /** + * Creates a new group + * + * @param subject the new group's name + * @param timer the default ephemeral timer for messages sent in this group + * @param parentGroup the community to whom the new group will be linked + * @return a CompletableFuture + */ + public CompletableFuture> createGroup(String subject, ChatEphemeralTimer timer, JidProvider parentGroup) { + return createGroup(subject, timer, parentGroup, new JidProvider[0]); + } + + /** + * Creates a new group + * + * @param subject the new group's name + * @param timer the default ephemeral timer for messages sent in this group + * @param parentCommunity the community to whom the new group will be linked + * @param contacts at least one contact to add to the group, not enforced if part of a community + * @return a CompletableFuture + */ + public CompletableFuture> createGroup(String subject, ChatEphemeralTimer timer, JidProvider parentCommunity, JidProvider... contacts) { + var timestamp = Clock.nowSeconds(); + Validate.isTrue(!subject.isBlank(), "The subject of a group cannot be blank"); + Validate.isTrue( parentCommunity != null || contacts.length >= 1, "Expected at least 1 member for this group"); + var children = new ArrayList(); + if (parentCommunity != null) { + children.add(Node.of("linked_parent", Map.of("jid", parentCommunity.toJid()))); + } + if (timer != ChatEphemeralTimer.OFF) { + children.add(Node.of("ephemeral", Map.of("expiration", timer.periodSeconds()))); + } + children.add(Node.of("member_add_mode", "all_member_add".getBytes(StandardCharsets.UTF_8))); + children.add(Node.of("membership_approval_mode", Node.of("group_join", Map.of("state", "off")))); + Arrays.stream(contacts) + .map(contact -> Node.of("participant", Map.of("jid", checkGroupParticipantJid(contact.toJid(), "Cannot create group with yourself as a participant")))) + .forEach(children::add); + + var body = Node.of("create", Map.of("subject", subject, "key", timestamp), children); + return socketHandler.sendQuery(JidServer.GROUP.toJid(), "set", "w:g2", body) + .thenApplyAsync(this::parseGroupResponse); + } + + private Optional parseGroupResponse(Node response) { + return Optional.ofNullable(response) + .flatMap(node -> node.findNode("group")) + .map(socketHandler::parseGroupMetadata) + .map(this::addNewGroup); + } + + private GroupMetadata addNewGroup(GroupMetadata result) { + var chatBuilder = new ChatBuilder() + .jid(result.jid()) + .description(result.description().orElse(null)) + .participants(new ArrayList<>(result.participants())) + .founder(result.founder().orElse(null)); + result.foundationTimestamp() + .map(ChronoZonedDateTime::toEpochSecond) + .ifPresent(chatBuilder::foundationTimestampSeconds); + store().addChat(chatBuilder.build()); + return result; + } + + private String findErrorNode(Node result) { + return Optional.ofNullable(result) + .flatMap(node -> node.findNode("error")) + .map(Node::toString) + .orElseGet(() -> Objects.toString(result)); + } + + /** + * Leaves a group + * + * @param group the target group + * @throws IllegalArgumentException if the provided chat is not a group + */ + public CompletableFuture leaveGroup(JidProvider group) { + var body = Node.of("leave", Node.of("group", Map.of("id", group.toJid()))); + return socketHandler.sendQuery(JidServer.GROUP.toJid(), "set", "w:g2", body) + .thenAcceptAsync(ignored -> handleLeaveGroup(group)); + } + + private void handleLeaveGroup(JidProvider group) { + var chat = group instanceof Chat entry ? entry : store() + .findChatByJid(group) + .orElse(null); + if (chat != null) { + var pastParticipant = new GroupPastParticipantBuilder() + .jid(jidOrThrowError().toSimpleJid()) + .reason(GroupPastParticipant.Reason.REMOVED) + .timestampSeconds(Clock.nowSeconds()) + .build(); + chat.addPastParticipant(pastParticipant); + } + } + + /** + * Links any number of groups to a community + * + * @param community the non-null community where the groups will be added + * @param groups the non-null groups to add + * @return a CompletableFuture that wraps a map guaranteed to contain every group that was provided as input paired to whether the request was successful + */ + public CompletableFuture> linkGroupsToCommunity(JidProvider community, JidProvider... groups) { + var body = Arrays.stream(groups) + .map(entry -> Node.of("group", Map.of("jid", entry.toJid()))) + .toArray(Node[]::new); + return socketHandler.sendQuery(community.toJid(), "set", "w:g2", Node.of("links", Node.of("link", Map.of("link_type", "sub_group"), body))) + .thenApplyAsync(result -> parseLinksResponse(result, groups)); + } + + private Map parseLinksResponse(Node result, JidProvider[] groups) { + var success = result.findNode("links") + .stream() + .map(entry -> entry.findNodes("link")) + .flatMap(Collection::stream) + .filter(entry -> entry.attributes().hasValue("link_type", "sub_group")) + .map(entry -> entry.findNode("group")) + .flatMap(Optional::stream) + .map(entry -> entry.attributes().getOptionalJid("jid")) + .flatMap(Optional::stream) + .collect(Collectors.toUnmodifiableSet()); + return Arrays.stream(groups) + .map(JidProvider::toJid) + .collect(Collectors.toUnmodifiableMap(Function.identity(), success::contains)); + } + + /** + * Unlinks a group from a community + * + * @param community the non-null parent community + * @param group the non-null group to unlink + * @return a CompletableFuture that indicates whether the request was successful + */ + public CompletableFuture unlinkGroupFromCommunity(JidProvider community, JidProvider group) { + return socketHandler.sendQuery(community.toJid(), "set", "w:g2", Node.of("unlink", Map.of("unlink_type", "sub_group"), Node.of("group", Map.of("jid", group.toJid())))) + .thenApplyAsync(result -> parseUnlinkResponse(result, group)); + } + + private boolean parseUnlinkResponse(Node result, JidProvider group) { + return result.findNode("unlink") + .filter(entry -> entry.attributes().hasValue("unlink_type", "sub_group")) + .flatMap(entry -> entry.findNode("group")) + .map(entry -> entry.attributes().hasValue("jid", group.toJid().toString())) + .isPresent(); + } + + /** + * Mutes a chat indefinitely + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture muteChat(JidProvider chat) { + return muteChat(chat, ChatMute.muted()); + } + + /** + * Mutes a chat + * + * @param chat the target chat + * @param mute the type of mute + * @return a CompletableFuture + */ + public CompletableFuture muteChat(JidProvider chat, ChatMute mute) { + if (store().clientType() == ClientType.MOBILE) { + // TODO: Send notification to companions + store().findChatByJid(chat) + .ifPresent(entry -> entry.setMute(mute)); + return CompletableFuture.completedFuture(null); + } + + var endTimeStamp = mute.type() == ChatMute.Type.MUTED_FOR_TIMEFRAME ? mute.endTimeStamp() * 1000L : mute.endTimeStamp(); + var muteAction = new MuteAction(true, OptionalLong.of(endTimeStamp), false); + var syncAction = ActionValueSync.of(muteAction); + var entry = PatchEntry.of(syncAction, Operation.SET, chat.toJid().toString()); + var request = new PatchRequest(PatchType.REGULAR_HIGH, List.of(entry)); + return socketHandler.pushPatch(request); + } + + /** + * Unmutes a chat + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture unmuteChat(JidProvider chat) { + if (store().clientType() == ClientType.MOBILE) { + // TODO: Send notification to companions + store().findChatByJid(chat) + .ifPresent(entry -> entry.setMute(ChatMute.notMuted())); + return CompletableFuture.completedFuture(null); + } + + var muteAction = new MuteAction(false, null, false); + var syncAction = ActionValueSync.of(muteAction); + var entry = PatchEntry.of(syncAction, Operation.SET, chat.toJid().toString()); + var request = new PatchRequest(PatchType.REGULAR_HIGH, List.of(entry)); + return socketHandler.pushPatch(request); + } + + /** + * Blocks a contact + * + * @param contact the target chat + * @return a CompletableFuture + */ + public CompletableFuture blockContact(JidProvider contact) { + var body = Node.of("item", Map.of("action", "block", "jid", contact.toJid())); + return socketHandler.sendQuery("set", "blocklist", body) + .thenRun(() -> {}); + } + + /** + * Unblocks a contact + * + * @param contact the target chat + * @return a CompletableFuture + */ + public CompletableFuture unblockContact(JidProvider contact) { + var body = Node.of("item", Map.of("action", "unblock", "jid", contact.toJid())); + return socketHandler.sendQuery("set", "blocklist", body) + .thenRun(() -> {}); + } + + /** + * Enables ephemeral messages in a chat, this means that messages will be automatically cancelled + * in said chat after a week + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture changeEphemeralTimer(JidProvider chat, ChatEphemeralTimer timer) { + return switch (chat.toJid().server()) { + case USER, WHATSAPP -> { + var message = new ProtocolMessageBuilder() + .protocolType(ProtocolMessage.Type.EPHEMERAL_SETTING) + .ephemeralExpiration(timer.period().toSeconds()) + .build(); + yield sendMessage(chat, message) + .thenRun(() -> { + }); + } + case GROUP -> { + var body = timer == ChatEphemeralTimer.OFF ? Node.of("not_ephemeral") : Node.of("ephemeral", Map.of("expiration", timer.period() + .toSeconds())); + yield socketHandler.sendQuery(chat.toJid(), "set", "w:g2", body) + .thenRun(() -> { + }); + } + default -> + throw new IllegalArgumentException("Unexpected chat %s: ephemeral messages are only supported for conversations and groups".formatted(chat.toJid())); + }; + } + + /** + * Marks a message as played + * + * @param info the target message + * @return a CompletableFuture + */ + public CompletableFuture markMessagePlayed(ChatMessageInfo info) { + if (store().findPrivacySetting(PrivacySettingType.READ_RECEIPTS).value() != PrivacySettingValue.EVERYONE) { + return CompletableFuture.completedFuture(info); + } + socketHandler.sendReceipt(info.chatJid(), info.senderJid(), List.of(info.id()), "played"); + info.setStatus(MessageStatus.PLAYED); + return CompletableFuture.completedFuture(info); + } + + /** + * Pins a chat to the top. A maximum of three chats can be pinned to the top. This condition can + * be checked using;. + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture pinChat(JidProvider chat) { + return pinChat(chat, true); + } + + /** + * Unpins a chat from the top + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture unpinChat(JidProvider chat) { + return pinChat(chat, false); + } + + private CompletableFuture pinChat(JidProvider chat, boolean pin) { + if (store().clientType() == ClientType.MOBILE) { + // TODO: Send notification to companions + store().findChatByJid(chat) + .ifPresent(entry -> entry.setPinnedTimestampSeconds(pin ? (int) Clock.nowSeconds() : 0)); + return CompletableFuture.completedFuture(null); + } + + var pinAction = new PinAction(pin); + var syncAction = ActionValueSync.of(pinAction); + var entry = PatchEntry.of(syncAction, Operation.SET, chat.toJid().toString()); + var request = new PatchRequest(PatchType.REGULAR_LOW, List.of(entry)); + return socketHandler.pushPatch(request); + } + + /** + * Stars a message + * + * @param info the target message + * @return a CompletableFuture + */ + public CompletableFuture starMessage(ChatMessageInfo info) { + return starMessage(info, true); + } + + private CompletableFuture starMessage(ChatMessageInfo info, boolean star) { + if (store().clientType() == ClientType.MOBILE) { + // TODO: Send notification to companions + info.setStarred(star); + return CompletableFuture.completedFuture(info); + } + + var starAction = new StarAction(star); + var syncAction = ActionValueSync.of(starAction); + var entry = PatchEntry.of(syncAction, Operation.SET, info.chatJid() + .toString(), info.id(), fromMeToFlag(info), participantToFlag(info)); + var request = new PatchRequest(PatchType.REGULAR_HIGH, List.of(entry)); + return socketHandler.pushPatch(request).thenApplyAsync(ignored -> info); + } + + private String fromMeToFlag(MessageInfo info) { + var fromMe = Objects.equals(info.senderJid().toSimpleJid(), jidOrThrowError().toSimpleJid()); + return booleanToInt(fromMe); + } + + private String participantToFlag(MessageInfo info) { + var fromMe = Objects.equals(info.senderJid().toSimpleJid(), jidOrThrowError().toSimpleJid()); + return info.parentJid().hasServer(JidServer.GROUP) + && !fromMe ? info.senderJid().toString() : "0"; + } + + private String booleanToInt(boolean keepStarredMessages) { + return keepStarredMessages ? "1" : "0"; + } + + /** + * Removes star from a message + * + * @param info the target message + * @return a CompletableFuture + */ + public CompletableFuture unstarMessage(ChatMessageInfo info) { + return starMessage(info, false); + } + + /** + * Archives a chat. If said chat is pinned, it will be unpinned. + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture archiveChat(JidProvider chat) { + return archiveChat(chat, true); + } + + private CompletableFuture archiveChat(JidProvider chat, boolean archive) { + if (store().clientType() == ClientType.MOBILE) { + // TODO: Send notification to companions + store().findChatByJid(chat) + .ifPresent(entry -> entry.setArchived(archive)); + return CompletableFuture.completedFuture(null); + } + + var range = createRange(chat, false); + var archiveAction = new ArchiveChatAction(archive, Optional.of(range)); + var syncAction = ActionValueSync.of(archiveAction); + var entry = PatchEntry.of(syncAction, Operation.SET, chat.toJid().toString()); + var request = new PatchRequest(PatchType.REGULAR_LOW, List.of(entry)); + return socketHandler.pushPatch(request); + } + + /** + * Unarchives a chat + * + * @param chat the target chat + * @return a CompletableFuture + */ + public CompletableFuture unarchive(JidProvider chat) { + return archiveChat(chat, false); + } + + /** + * Deletes a message + * + * @param messageInfo the non-null message to delete + * @return a CompletableFuture + */ + public CompletableFuture deleteMessage(NewsletterMessageInfo messageInfo) { + var revokeInfo = new NewsletterMessageInfo( + messageInfo.id(), + messageInfo.serverId(), + Clock.nowSeconds(), + null, + new ConcurrentHashMap<>(), + MessageContainer.empty(), + MessageStatus.PENDING + ); + revokeInfo.setNewsletter(messageInfo.newsletter()); + var attrs = Map.of("edit", getDeleteBit(messageInfo)); + var request = new MessageSendRequest.Newsletter(revokeInfo, attrs); + return socketHandler.sendMessage(request); + } + + /** + * Deletes a message + * + * @param messageInfo non-null message to delete + * @param everyone whether the message should be deleted for everyone or only for this client and + * its companions + * @return a CompletableFuture + */ + public CompletableFuture deleteMessage(ChatMessageInfo messageInfo, boolean everyone) { + if (everyone) { + var message = new ProtocolMessageBuilder() + .protocolType(ProtocolMessage.Type.REVOKE) + .key(messageInfo.key()) + .build(); + var sender = messageInfo.chatJid().hasServer(JidServer.GROUP) ? jidOrThrowError() : null; + var key = new ChatMessageKeyBuilder() + .id(ChatMessageKey.randomId()) + .chatJid(messageInfo.chatJid()) + .fromMe(true) + .senderJid(sender) + .build(); + var revokeInfo = new ChatMessageInfoBuilder() + .status(MessageStatus.PENDING) + .senderJid(sender) + .key(key) + .message(MessageContainer.of(message)) + .timestampSeconds(Clock.nowSeconds()) + .build(); + var attrs = Map.of("edit", getDeleteBit(messageInfo)); + var request = new MessageSendRequest.Chat(revokeInfo, null, false, false, attrs); + return socketHandler.sendMessage(request); + } + + return switch (store().clientType()) { + case WEB -> { + var range = createRange(messageInfo.chatJid(), false); + var deleteMessageAction = new DeleteMessageForMeAction(false, messageInfo.timestampSeconds().orElse(0L)); + var syncAction = ActionValueSync.of(deleteMessageAction); + var entry = PatchEntry.of(syncAction, Operation.SET, messageInfo.chatJid().toString(), messageInfo.id(), fromMeToFlag(messageInfo), participantToFlag(messageInfo)); + var request = new PatchRequest(PatchType.REGULAR_HIGH, List.of(entry)); + yield socketHandler.pushPatch(request); + } + case MOBILE -> { + // TODO: Send notification to companions + messageInfo.chat().ifPresent(chat -> chat.removeMessage(messageInfo)); + yield CompletableFuture.completedFuture(null); + } + }; + } + + + private int getEditBit(MessageInfo info) { + if (info.parentJid().hasServer(JidServer.NEWSLETTER)) { + return 3; + } + + return 1; + } + + private int getDeleteBit(MessageInfo info) { + if (info.parentJid().hasServer(JidServer.NEWSLETTER)) { + return 8; + } + + var fromMe = Objects.equals(info.senderJid().toSimpleJid(), jidOrThrowError().toSimpleJid()); + if (info.parentJid().hasServer(JidServer.GROUP) && !fromMe) { + return 8; + } + + return 7; + } + + /** + * Deletes a chat for this client and its companions using a modern version of Whatsapp Important: + * this message doesn't seem to work always as of now + * + * @param chat the non-null chat to delete + * @return a CompletableFuture + */ + public CompletableFuture deleteChat(JidProvider chat) { + if (store().clientType() == ClientType.MOBILE) { + // TODO: Send notification to companions + store().removeChat(chat.toJid()); + return CompletableFuture.completedFuture(null); + } + + var range = createRange(chat.toJid(), false); + var deleteChatAction = new DeleteChatAction(Optional.of(range)); + var syncAction = ActionValueSync.of(deleteChatAction); + var entry = PatchEntry.of(syncAction, Operation.SET, chat.toJid().toString(), "1"); + var request = new PatchRequest(PatchType.REGULAR_HIGH, List.of(entry)); + return socketHandler.pushPatch(request); + } + + /** + * Clears the content of a chat for this client and its companions using a modern version of + * Whatsapp Important: this message doesn't seem to work always as of now + * + * @param chat the non-null chat to clear + * @param keepStarredMessages whether starred messages in this chat should be kept + * @return a CompletableFuture + */ + public CompletableFuture clearChat(JidProvider chat, boolean keepStarredMessages) { + if (store().clientType() == ClientType.MOBILE) { + // TODO: Send notification to companions + store().findChatByJid(chat.toJid()) + .ifPresent(Chat::removeMessages); + return CompletableFuture.completedFuture(null); + } + + var known = store().findChatByJid(chat); + var range = createRange(chat.toJid(), true); + var clearChatAction = new ClearChatAction(Optional.of(range)); + var syncAction = ActionValueSync.of(clearChatAction); + var entry = PatchEntry.of(syncAction, Operation.SET, chat.toJid().toString(), booleanToInt(keepStarredMessages), "0"); + var request = new PatchRequest(PatchType.REGULAR_HIGH, List.of(entry)); + return socketHandler.pushPatch(request); + } + + /** + * Change the description of this business profile + * + * @param description the new description, can be null + * @return a CompletableFuture + */ + public CompletableFuture changeBusinessDescription(String description) { + return changeBusinessAttribute("description", description); + } + + private CompletableFuture changeBusinessAttribute(String key, String value) { + return socketHandler.sendQuery("set", "w:biz", Node.of("business_profile", Map.of("v", "3", "mutation_type", "delta"), Node.of(key, Objects.requireNonNullElse(value, "").getBytes(StandardCharsets.UTF_8)))) + .thenAcceptAsync(result -> checkBusinessAttributeConflict(key, value, result)) + .thenApplyAsync(ignored -> value); + } + + private void checkBusinessAttributeConflict(String key, String value, Node result) { + var keyNode = result.findNode("profile").flatMap(entry -> entry.findNode(key)); + if (keyNode.isEmpty()) { + return; + } + var actual = keyNode.get() + .contentAsString() + .orElseThrow(() -> new NoSuchElementException("Missing business %s newsletters, something went wrong: %s".formatted(key, findErrorNode(result)))); + Validate.isTrue(value == null || value.equals(actual), "Cannot change business %s: conflict(expected %s, got %s)", key, value, actual); + } + + /** + * Change the address of this business profile + * + * @param address the new address, can be null + * @return a CompletableFuture + */ + public CompletableFuture changeBusinessAddress(String address) { + return changeBusinessAttribute("address", address); + } + + /** + * Change the email of this business profile + * + * @param email the new email, can be null + * @return a CompletableFuture + */ + public CompletableFuture changeBusinessEmail(String email) { + Validate.isTrue(email == null || isValidEmail(email), "Invalid email: %s", email); + return changeBusinessAttribute("email", email); + } + + private boolean isValidEmail(String email) { + return Pattern.compile("^(.+)@(\\S+)$") + .matcher(email) + .matches(); + } + + /** + * Change the categories of this business profile + * + * @param categories the new categories, can be null + * @return a CompletableFuture + */ + public CompletableFuture> changeBusinessCategories(List categories) { + return socketHandler.sendQuery("set", "w:biz", Node.of("business_profile", Map.of("v", "3", "mutation_type", "delta"), Node.of("categories", createCategories(categories)))) + .thenApplyAsync(ignored -> categories); + } + + private Collection createCategories(List categories) { + if (categories == null) { + return List.of(); + } + return categories.stream().map(entry -> Node.of("category", Map.of("id", entry.id()))).toList(); + } + + /** + * Change the websites of this business profile + * + * @param websites the new websites, can be null + * @return a CompletableFuture + */ + public CompletableFuture> changeBusinessWebsites(List websites) { + return socketHandler.sendQuery("set", "w:biz", Node.of("business_profile", Map.of("v", "3", "mutation_type", "delta"), createWebsites(websites))) + .thenApplyAsync(ignored -> websites); + } + + private List createWebsites(List websites) { + if (websites == null) { + return List.of(); + } + return websites.stream() + .map(entry -> Node.of("website", entry.toString().getBytes(StandardCharsets.UTF_8))) + .toList(); + } + + /** + * Query the catalog of this business + * + * @return a CompletableFuture + */ + public CompletableFuture> queryBusinessCatalog() { + return queryBusinessCatalog(10); + } + + /** + * Query the catalog of this business + * + * @param productsLimit the maximum number of products to query + * @return a CompletableFuture + */ + public CompletableFuture> queryBusinessCatalog(int productsLimit) { + return queryBusinessCatalog(jidOrThrowError().toSimpleJid(), productsLimit); + } + + /** + * Query the catalog of a business + * + * @param contact the business + * @param productsLimit the maximum number of products to query + * @return a CompletableFuture + */ + public CompletableFuture> queryBusinessCatalog(JidProvider contact, int productsLimit) { + return socketHandler.sendQuery("get", "w:biz:catalog", Node.of("product_catalog", Map.of("jid", contact, "allow_shop_source", "true"), Node.of("limit", String.valueOf(productsLimit) + .getBytes(StandardCharsets.UTF_8)), Node.of("width", "100".getBytes(StandardCharsets.UTF_8)), Node.of("height", "100".getBytes(StandardCharsets.UTF_8)))) + .thenApplyAsync(this::parseCatalog); + } + + private List parseCatalog(Node result) { + return Objects.requireNonNull(result, "Cannot query business catalog, missing newsletters node") + .findNode("product_catalog") + .map(entry -> entry.findNodes("product")) + .stream() + .flatMap(Collection::stream) + .map(BusinessCatalogEntry::of) + .toList(); + } + + /** + * Query the catalog of a business + * + * @param contact the business + * @return a CompletableFuture + */ + public CompletableFuture> queryBusinessCatalog(JidProvider contact) { + return queryBusinessCatalog(contact, 10); + } + + /** + * Query the collections of this business + * + * @return a CompletableFuture + */ + public CompletableFuture queryBusinessCollections() { + return queryBusinessCollections(50); + } + + /** + * Query the collections of this business + * + * @param collectionsLimit the maximum number of collections to query + * @return a CompletableFuture + */ + public CompletableFuture queryBusinessCollections(int collectionsLimit) { + return queryBusinessCollections(jidOrThrowError().toSimpleJid(), collectionsLimit); + } + + /** + * Query the collections of a business + * + * @param contact the business + * @param collectionsLimit the maximum number of collections to query + * @return a CompletableFuture + */ + public CompletableFuture> queryBusinessCollections(JidProvider contact, int collectionsLimit) { + return socketHandler.sendQuery("get", "w:biz:catalog", Map.of("smax_id", "35"), Node.of("collections", Map.of("biz_jid", contact), Node.of("collection_limit", String.valueOf(collectionsLimit) + .getBytes(StandardCharsets.UTF_8)), Node.of("item_limit", String.valueOf(collectionsLimit) + .getBytes(StandardCharsets.UTF_8)), Node.of("width", "100".getBytes(StandardCharsets.UTF_8)), Node.of("height", "100".getBytes(StandardCharsets.UTF_8)))) + .thenApplyAsync(this::parseCollections); + } + + private List parseCollections(Node result) { + return Objects.requireNonNull(result, "Cannot query business collections, missing newsletters node") + .findNode("collections") + .stream() + .map(entry -> entry.findNodes("collection")) + .flatMap(Collection::stream) + .map(BusinessCollectionEntry::of) + .toList(); + } + + /** + * Query the collections of a business + * + * @param contact the business + * @return a CompletableFuture + */ + public CompletableFuture queryBusinessCollections(JidProvider contact) { + return queryBusinessCollections(contact, 50); + } + + /** + * Downloads a media from Whatsapp's servers. + * If the media was already downloaded, the cached version will be returned. + * If the download fails because the media is too old/invalid, a reupload request will be sent to Whatsapp. + * If the latter fails as well, an empty optional will be returned. + * + * @param info the non-null message info wrapping the media + * @return a CompletableFuture + */ + public CompletableFuture> downloadMedia(ChatMessageInfo info) { + if (!(info.message().content() instanceof MediaMessage mediaMessage)) { + throw new IllegalArgumentException("Expected media message, got: " + info.message().category()); + } + + return downloadMedia(mediaMessage).thenCompose(result -> { + if (result.isPresent()) { + return CompletableFuture.completedFuture(result); + } + + return requireMediaReupload(info) + .thenCompose(ignored -> downloadMedia(mediaMessage)); + }); + } + + /** + * Downloads a media from Whatsapp's servers. + * If the media was already downloaded, the cached version will be returned. + * If the download fails because the media is too old/invalid, an empty optional will be returned. + * + * @param info the non-null message info wrapping the media + * @return a CompletableFuture + */ + public CompletableFuture> downloadMedia(NewsletterMessageInfo info) { + if (!(info.message().content() instanceof MediaMessage mediaMessage)) { + throw new IllegalArgumentException("Expected media message, got: " + info.message().category()); + } + + return downloadMedia(mediaMessage); + } + + /** + * Downloads a media from Whatsapp's servers. + * If the media was already downloaded, the cached version will be returned. + * If the download fails because the media is too old/invalid, an empty optional will be returned. + * + * @param mediaMessage the non-null media + * @return a CompletableFuture + */ + public CompletableFuture> downloadMedia(MediaMessage mediaMessage) { + if (!(mediaMessage instanceof ExtendedMediaMessage extendedMediaMessage)) { + return Medias.downloadAsync(mediaMessage); + } + + var decodedMedia = extendedMediaMessage.decodedMedia(); + if (decodedMedia.isPresent()) { + return CompletableFuture.completedFuture(decodedMedia); + } + + + return Medias.downloadAsync(mediaMessage).thenApply(result -> { + result.ifPresent(extendedMediaMessage::setDecodedMedia); + return result; + }); + } + + /** + * Asks Whatsapp for a media reupload for a specific media + * + * @param info the non-null message info wrapping the media + * @return a CompletableFuture + */ + public CompletableFuture requireMediaReupload(ChatMessageInfo info) { + if (!(info.message().content() instanceof MediaMessage mediaMessage)) { + throw new IllegalArgumentException("Expected media message, got: " + info.message().category()); + } + + var mediaKey = mediaMessage.mediaKey() + .orElseThrow(() -> new NoSuchElementException("Missing media key")); + var retryKey = Hkdf.extractAndExpand(mediaKey, "WhatsApp Media Retry Notification".getBytes(StandardCharsets.UTF_8), 32); + var retryIv = Bytes.random(12); + var retryIdData = info.key().id().getBytes(StandardCharsets.UTF_8); + var receipt = ServerErrorReceiptSpec.encode(new ServerErrorReceipt(info.id())); + var ciphertext = AesGcm.encrypt(retryIv, receipt, retryKey, retryIdData); + var rmrAttributes = Attributes.of() + .put("jid", info.chatJid()) + .put("from_me", String.valueOf(info.fromMe())) + .put("participant", info.senderJid(), () -> !Objects.equals(info.chatJid(), info.senderJid())) + .toMap(); + var node = Node.of("receipt", Map.of("id", info.key().id(), "to", jidOrThrowError() + .toSimpleJid(), "type", "server-error"), Node.of("encrypt", Node.of("enc_p", ciphertext), Node.of("enc_iv", retryIv)), Node.of("rmr", rmrAttributes)); + return socketHandler.send(node, result -> result.hasDescription("notification")) + .thenAcceptAsync(result -> parseMediaReupload(info, mediaMessage, retryKey, retryIdData, result)); + } + + private void parseMediaReupload(ChatMessageInfo info, MediaMessage mediaMessage, byte[] retryKey, byte[] retryIdData, Node node) { + Validate.isTrue(!node.hasNode("error"), "Erroneous response from media reupload: %s", node.attributes() + .getInt("code")); + var encryptNode = node.findNode("encrypt") + .orElseThrow(() -> new NoSuchElementException("Missing encrypt node in media reupload")); + var mediaPayload = encryptNode.findNode("enc_p") + .flatMap(Node::contentAsBytes) + .orElseThrow(() -> new NoSuchElementException("Missing encrypted payload node in media reupload")); + var mediaIv = encryptNode.findNode("enc_iv") + .flatMap(Node::contentAsBytes) + .orElseThrow(() -> new NoSuchElementException("Missing encrypted iv node in media reupload")); + var mediaRetryNotificationData = AesGcm.decrypt(mediaIv, mediaPayload, retryKey, retryIdData); + var mediaRetryNotification = MediaRetryNotificationSpec.decode(mediaRetryNotificationData); + var directPath = mediaRetryNotification.directPath() + .orElseThrow(() -> new RuntimeException("Media reupload failed")); + mediaMessage.setMediaUrl(Medias.createMediaUrl(directPath)); + mediaMessage.setMediaDirectPath(directPath); + } + + /** + * Sends a custom node to Whatsapp + * + * @param node the non-null node to send + * @return the newsletters from Whatsapp + */ + public CompletableFuture sendNode(Node node) { + return socketHandler.send(node); + } + + /** + * Creates a new community + * + * @param subject the non-null name of the new community + * @param body the nullable description of the new community + * @return a CompletableFuture + */ + public CompletableFuture> createCommunity(String subject, String body) { + var descriptionId = HexFormat.of().formatHex(Bytes.random(12)); + var entry = Node.of("create", Map.of("subject", subject), + Node.of("description", Map.of("id", descriptionId), + Node.of("body", Objects.requireNonNullElse(body, "").getBytes(StandardCharsets.UTF_8))), + Node.of("parent", Map.of("default_membership_approval_mode", "request_required")), + Node.of("allow_non_admin_sub_group_creation")); + return socketHandler.sendQuery(JidServer.GROUP.toJid(), "set", "w:g2", entry) + .thenApplyAsync(node -> node.findNode("group").map(socketHandler::parseGroupMetadata)); + } + + /** + * Changes a community setting + * + * @param community the non-null community affected by this change + * @param setting the non-null setting + * @param policy the non-null policy + * @return a future + */ + public CompletableFuture changeCommunitySetting(JidProvider community, CommunitySetting setting, ChatSettingPolicy policy) { + Validate.isTrue(community.toJid().hasServer(JidServer.GROUP), "This method only accepts communities"); + var body = switch (setting) { + case MODIFY_GROUPS -> + Node.of(policy == ChatSettingPolicy.ANYONE ? "allow_non_admin_sub_group_creation" : "not_allow_non_admin_sub_group_creation"); + }; + return socketHandler.sendQuery(JidServer.GROUP.toJid(), "set", "w:g2", body) + .thenRun(() -> {}); + } + + + /** + * Unlinks all the companions of this device + * + * @return a future + */ + public CompletableFuture unlinkDevices() { + return socketHandler.sendQuery("set", "md", Node.of("remove-companion-device", Map.of("all", true, "reason", "user_initiated"))) + .thenRun(() -> store().removeLinkedCompanions()) + .thenApply(ignored -> this); + } + + /** + * Unlinks a specific companion + * + * @param companion the non-null companion to unlink + * @return a future + */ + public CompletableFuture unlinkDevice(Jid companion) { + Validate.isTrue(companion.hasAgent(), "Expected companion, got jid without agent: %s", companion); + return socketHandler.sendQuery("set", "md", Node.of("remove-companion-device", Map.of("jid", companion, "reason", "user_initiated"))) + .thenRun(() -> store().removeLinkedCompanion(companion)) + .thenApply(ignored -> this); + } + + /** + * Links a companion to this device + * + * @param qrCode the non-null qr code as an image + * @return a future + */ + public CompletableFuture linkDevice(byte[] qrCode) { + try { + var inputStream = new ByteArrayInputStream(qrCode); + var luminanceSource = new BufferedImageLuminanceSource(ImageIO.read(inputStream)); + var hybridBinarizer = new HybridBinarizer(luminanceSource); + var binaryBitmap = new BinaryBitmap(hybridBinarizer); + var reader = new QRCodeReader(); + var result = reader.decode(binaryBitmap); + return linkDevice(result.getText()); + } catch (IOException | NotFoundException | ChecksumException | FormatException exception) { + throw new IllegalArgumentException("Cannot read qr code", exception); + } + } + + /** + * Links a companion to this device + * Mobile api only + * + * @param qrCodeData the non-null qr code as a String + * @return a future + */ + public CompletableFuture linkDevice(String qrCodeData) { + Validate.isTrue(store().clientType() == ClientType.MOBILE, "Device linking is only available for the mobile api"); + var maxDevices = getMaxLinkedDevices(); + if (store().linkedDevices().size() > maxDevices) { + return CompletableFuture.completedFuture(CompanionLinkResult.MAX_DEVICES_ERROR); + } + + var qrCodeParts = qrCodeData.split(","); + Validate.isTrue(qrCodeParts.length >= 4, "Expected qr code to be made up of at least four parts"); + var ref = qrCodeParts[0]; + var publicKey = Base64.getDecoder().decode(qrCodeParts[1]); + var advIdentity = Base64.getDecoder().decode(qrCodeParts[2]); + var identityKey = Base64.getDecoder().decode(qrCodeParts[3]); + return socketHandler.sendQuery("set", "w:sync:app:state", Node.of("delete_all_data")) + .thenComposeAsync(ignored -> linkDevice(advIdentity, identityKey, ref, publicKey)); + } + + private CompletableFuture linkDevice(byte[] advIdentity, byte[] identityKey, String ref, byte[] publicKey) { + var deviceIdentity = new DeviceIdentityBuilder() + .rawId(ThreadLocalRandom.current().nextInt(800_000_000, 900_000_000)) + .keyIndex(store().linkedDevices().size() + 1) + .timestamp(Clock.nowSeconds()) + .build(); + var deviceIdentityBytes = DeviceIdentitySpec.encode(deviceIdentity); + var accountSignatureMessage = Bytes.concat( + Specification.Whatsapp.ACCOUNT_SIGNATURE_HEADER, + deviceIdentityBytes, + advIdentity + ); + var accountSignature = Curve25519.sign(keys().identityKeyPair().privateKey(), accountSignatureMessage, true); + var signedDeviceIdentity = new SignedDeviceIdentityBuilder() + .accountSignature(accountSignature) + .accountSignatureKey(keys().identityKeyPair().publicKey()) + .details(deviceIdentityBytes) + .build(); + var signedDeviceIdentityBytes = SignedDeviceIdentitySpec.encode(signedDeviceIdentity); + var deviceIdentityHmac = new SignedDeviceIdentityHMACBuilder() + .hmac(Hmac.calculateSha256(signedDeviceIdentityBytes, identityKey)) + .details(signedDeviceIdentityBytes) + .build(); + var knownDevices = store().linkedDevices() + .stream() + .map(Jid::device) + .toList(); + var keyIndexList = new KeyIndexListBuilder() + .rawId(deviceIdentity.rawId()) + .timestamp(deviceIdentity.timestamp()) + .validIndexes(knownDevices) + .build(); + var keyIndexListBytes = KeyIndexListSpec.encode(keyIndexList); + var deviceSignatureMessage = Bytes.concat(Specification.Whatsapp.DEVICE_MOBILE_SIGNATURE_HEADER, keyIndexListBytes); + var keyAccountSignature = Curve25519.sign(keys().identityKeyPair().privateKey(), deviceSignatureMessage, true); + var signedKeyIndexList = new SignedKeyIndexListBuilder() + .accountSignature(keyAccountSignature) + .details(keyIndexListBytes) + .build(); + return socketHandler.sendQuery("set", "md", Node.of("pair-device", + Node.of("ref", ref), + Node.of("pub-key", publicKey), + Node.of("device-identity", SignedDeviceIdentityHMACSpec.encode(deviceIdentityHmac)), + Node.of("key-index-list", Map.of("ts", deviceIdentity.timestamp()), SignedKeyIndexListSpec.encode(signedKeyIndexList)))) + .thenComposeAsync(result -> handleCompanionPairing(result, deviceIdentity.keyIndex())); + } + + private int getMaxLinkedDevices() { + var maxDevices = socketHandler.store().properties().get("linked_device_max_count"); + if (maxDevices == null) { + return Specification.Whatsapp.MAX_COMPANIONS; + } + + try { + return Integer.parseInt(maxDevices); + } catch (NumberFormatException exception) { + return Specification.Whatsapp.MAX_COMPANIONS; + } + } + + private CompletableFuture handleCompanionPairing(Node result, int keyId) { + if (result.attributes().hasValue("type", "error")) { + var error = result.findNode("error") + .filter(entry -> entry.attributes().hasValue("text", "resource-limit")) + .map(entry -> CompanionLinkResult.MAX_DEVICES_ERROR) + .orElse(CompanionLinkResult.RETRY_ERROR); + return CompletableFuture.completedFuture(error); + } + + var device = result.findNode("device") + .flatMap(entry -> entry.attributes().getOptionalJid("jid")) + .orElse(null); + if (device == null) { + return CompletableFuture.completedFuture(CompanionLinkResult.RETRY_ERROR); + } + + return awaitCompanionRegistration(device) + .thenComposeAsync(ignored -> socketHandler.sendQuery("get", "encrypt", Node.of("key", Node.of("user", Map.of("jid", device))))) + .thenComposeAsync(encryptResult -> handleCompanionEncrypt(encryptResult, device, keyId)); + } + + private CompletableFuture awaitCompanionRegistration(Jid device) { + var future = new CompletableFuture(); + OnLinkedDevices listener = data -> { + if (data.contains(device)) { + future.complete(null); + } + }; + addLinkedDevicesListener(listener); + return future.orTimeout(Specification.Whatsapp.COMPANION_PAIRING_TIMEOUT, TimeUnit.SECONDS) + .exceptionally(ignored -> null) + .thenRun(() -> removeListener(listener)); + } + + private CompletableFuture handleCompanionEncrypt(Node result, Jid companion, int keyId) { + store().addLinkedDevice(companion, keyId); + socketHandler.parseSessions(result); + return sendInitialSecurityMessage(companion) + .thenComposeAsync(ignore -> sendAppStateKeysMessage(companion)) + .thenComposeAsync(ignore -> sendInitialNullMessage(companion)) + .thenComposeAsync(ignore -> sendInitialStatusMessage(companion)) + .thenComposeAsync(ignore -> sendPushNamesMessage(companion)) + .thenComposeAsync(ignore -> sendInitialBootstrapMessage(companion)) + .thenComposeAsync(ignore -> sendRecentMessage(companion)) + .thenComposeAsync(ignored -> syncCompanionState(companion)) + .thenApplyAsync(ignored -> CompanionLinkResult.SUCCESS); + } + + private CompletableFuture syncCompanionState(Jid companion) { + var criticalUnblockLowRequest = createCriticalUnblockLowRequest(); + var criticalBlockRequest = createCriticalBlockRequest(); + return socketHandler.pushPatches(companion, List.of(criticalBlockRequest, criticalUnblockLowRequest)).thenComposeAsync(ignored -> { + var regularLowRequests = createRegularLowRequests(); + var regularRequests = createRegularRequests(); + return socketHandler.pushPatches(companion, List.of(regularLowRequests, regularRequests)); + }); + } + + private PatchRequest createRegularRequests() { + return new PatchRequest(PatchType.REGULAR, List.of()); + } + + private PatchRequest createRegularLowRequests() { + var timeFormatEntry = createTimeFormatEntry(); + var primaryVersion = new PrimaryVersionAction(store().version().toString()); + var sessionVersionEntry = createPrimaryVersionEntry(primaryVersion, "session@s.whatsapp.net"); + var keepVersionEntry = createPrimaryVersionEntry(primaryVersion, "current@s.whatsapp.net"); + var nuxEntry = createNuxRequest(); + var androidEntry = createAndroidEntry(); + var entries = Stream.of(timeFormatEntry, sessionVersionEntry, keepVersionEntry, nuxEntry, androidEntry) + .filter(Objects::nonNull) + .toList(); + // TODO: Archive chat actions, StickerAction + return new PatchRequest(PatchType.REGULAR_LOW, entries); + } + + // FIXME: Settings can't be serialized + private PatchRequest createCriticalBlockRequest() { + var localeEntry = createLocaleEntry(); + var pushNameEntry = createPushNameEntry(); + return new PatchRequest(PatchType.CRITICAL_BLOCK, List.of(localeEntry, pushNameEntry)); + } + + private PatchRequest createCriticalUnblockLowRequest() { + var criticalUnblockLow = createContactEntries(); + return new PatchRequest(PatchType.CRITICAL_UNBLOCK_LOW, criticalUnblockLow); + } + + private List createContactEntries() { + return store().contacts() + .stream() + .filter(entry -> entry.shortName().isPresent() || entry.fullName().isPresent()) + .map(this::createContactRequestEntry) + .collect(Collectors.toList()); + } + + private PatchEntry createPushNameEntry() { + var pushNameSetting = new PushNameSettings(store().name()); + return PatchEntry.of(ActionValueSync.of(pushNameSetting), Operation.SET); + } + + private PatchEntry createLocaleEntry() { + var localeSetting = new LocaleSettings(store().locale().toString()); + return PatchEntry.of(ActionValueSync.of(localeSetting), Operation.SET); + } + + private PatchEntry createAndroidEntry() { + if (!store().device().platform().isAndroid()) { + return null; + } + + var action = new AndroidUnsupportedActions(true); + return PatchEntry.of(ActionValueSync.of(action), Operation.SET); + } + + private PatchEntry createNuxRequest() { + var nuxAction = new NuxAction(true); + var timeFormatSync = ActionValueSync.of(nuxAction); + return PatchEntry.of(timeFormatSync, Operation.SET, "keep@s.whatsapp.net"); + } + + private PatchEntry createPrimaryVersionEntry(PrimaryVersionAction primaryVersion, String to) { + var timeFormatSync = ActionValueSync.of(primaryVersion); + return PatchEntry.of(timeFormatSync, Operation.SET, to); + } + + private PatchEntry createTimeFormatEntry() { + var timeFormatAction = new TimeFormatAction(store().twentyFourHourFormat()); + var timeFormatSync = ActionValueSync.of(timeFormatAction); + return PatchEntry.of(timeFormatSync, Operation.SET); + } + + private PatchEntry createContactRequestEntry(Contact contact) { + var action = new ContactAction(null, contact.shortName(), contact.fullName()); + var sync = ActionValueSync.of(action); + return PatchEntry.of(sync, Operation.SET, contact.jid().toString()); + } + + private CompletableFuture sendRecentMessage(Jid jid) { + var pushNames = new HistorySyncBuilder() + .conversations(List.of()) + .syncType(HistorySync.Type.RECENT) + .build(); + return sendHistoryProtocolMessage(jid, pushNames, HistorySync.Type.PUSH_NAME); + } + + private CompletableFuture sendPushNamesMessage(Jid jid) { + var pushNamesData = store() + .contacts() + .stream() + .filter(entry -> entry.chosenName().isPresent()) + .map(entry -> new PushName(entry.jid().toString(), entry.chosenName())) + .toList(); + var pushNames = new HistorySyncBuilder() + .pushNames(pushNamesData) + .syncType(HistorySync.Type.PUSH_NAME) + .build(); + return sendHistoryProtocolMessage(jid, pushNames, HistorySync.Type.PUSH_NAME); + } + + private CompletableFuture sendInitialStatusMessage(Jid jid) { + var initialStatus = new HistorySyncBuilder() + .statusV3Messages(new ArrayList<>(store().status())) + .syncType(HistorySync.Type.INITIAL_STATUS_V3) + .build(); + return sendHistoryProtocolMessage(jid, initialStatus, HistorySync.Type.INITIAL_STATUS_V3); + } + + private CompletableFuture sendInitialBootstrapMessage(Jid jid) { + var chats = store().chats() + .stream() + .toList(); + var initialBootstrap = new HistorySyncBuilder() + .conversations(chats) + .syncType(HistorySync.Type.INITIAL_BOOTSTRAP) + .build(); + return sendHistoryProtocolMessage(jid, initialBootstrap, HistorySync.Type.INITIAL_BOOTSTRAP); + } + + private CompletableFuture sendInitialNullMessage(Jid jid) { + var pastParticipants = store().chats() + .stream() + .map(this::getPastParticipants) + .filter(Objects::nonNull) + .toList(); + var initialBootstrap = new HistorySyncBuilder() + .syncType(HistorySync.Type.NON_BLOCKING_DATA) + .pastParticipants(pastParticipants) + .build(); + return sendHistoryProtocolMessage(jid, initialBootstrap, null); + } + + private GroupPastParticipants getPastParticipants(Chat chat) { + if (chat.pastParticipants().isEmpty()) { + return null; + } + + return new GroupPastParticipantsBuilder() + .groupJid(chat.jid()) + .pastParticipants(new ArrayList<>(chat.pastParticipants())) + .build(); + } + + private CompletableFuture sendAppStateKeysMessage(Jid companion) { + var preKeys = IntStream.range(0, 10) + .mapToObj(index -> createAppKey(companion, index)) + .toList(); + keys().addAppKeys(companion, preKeys); + var appStateSyncKeyShare = new AppStateSyncKeyShareBuilder() + .keys(preKeys) + .build(); + var result = new ProtocolMessageBuilder() + .protocolType(ProtocolMessage.Type.APP_STATE_SYNC_KEY_SHARE) + .appStateSyncKeyShare(appStateSyncKeyShare) + .build(); + return socketHandler.sendPeerMessage(companion, result); + } + + private AppStateSyncKey createAppKey(Jid jid, int index) { + return new AppStateSyncKeyBuilder() + .keyId(new AppStateSyncKeyId(Bytes.intToBytes(ThreadLocalRandom.current().nextInt(19000, 20000), 6))) + .keyData(createAppKeyData(jid, index)) + .build(); + } + + private AppStateSyncKeyData createAppKeyData(Jid jid, int index) { + return new AppStateSyncKeyDataBuilder() + .keyData(SignalKeyPair.random().publicKey()) + .fingerprint(createAppKeyFingerprint(jid, index)) + .timestamp(Clock.nowMilliseconds()) + .build(); + } + + private AppStateSyncKeyFingerprint createAppKeyFingerprint(Jid jid, int index) { + return new AppStateSyncKeyFingerprintBuilder() + .rawId(ThreadLocalRandom.current().nextInt()) + .currentIndex(index) + .deviceIndexes(new ArrayList<>(store().linkedDevicesKeys().values())) + .build(); + } + + private CompletableFuture sendInitialSecurityMessage(Jid jid) { + var protocolMessage = new ProtocolMessageBuilder() + .protocolType(ProtocolMessage.Type.INITIAL_SECURITY_NOTIFICATION_SETTING_SYNC) + .initialSecurityNotificationSettingSync(new InitialSecurityNotificationSettingSync(true)) + .build(); + return socketHandler.sendPeerMessage(jid, protocolMessage); + } + + private CompletableFuture sendHistoryProtocolMessage(Jid jid, HistorySync historySync, HistorySync.Type type) { + var syncBytes = HistorySyncSpec.encode(historySync); + return Medias.upload(syncBytes, AttachmentType.HISTORY_SYNC, store().mediaConnection()) + .thenApplyAsync(upload -> createHistoryProtocolMessage(upload, type)) + .thenComposeAsync(result -> socketHandler.sendPeerMessage(jid, result)); + } + + private ProtocolMessage createHistoryProtocolMessage(MediaFile upload, HistorySync.Type type) { + var notification = new HistorySyncNotificationBuilder() + .mediaSha256(upload.fileSha256()) + .mediaEncryptedSha256(upload.fileEncSha256()) + .mediaKey(upload.mediaKey()) + .mediaDirectPath(upload.directPath()) + .mediaSize(upload.fileLength()) + .syncType(type) + .build(); + return new ProtocolMessageBuilder() + .protocolType(ProtocolMessage.Type.HISTORY_SYNC_NOTIFICATION) + .historySyncNotification(notification) + .build(); + } + + /** + * Gets the verified name certificate + * + * @return a future + */ + public CompletableFuture> queryBusinessCertificate(JidProvider provider) { + return socketHandler.sendQuery("get", "w:biz", Node.of("verified_name", Map.of("jid", provider.toJid()))) + .thenApplyAsync(this::parseCertificate); + } + + private Optional parseCertificate(Node result) { + return result.findNode("verified_name") + .flatMap(Node::contentAsBytes) + .map(BusinessVerifiedNameCertificateSpec::decode); + } + + /** + * Enables two-factor authentication + * Mobile API only + * + * @param code the six digits non-null numeric code + * @return a future + */ + public CompletableFuture enable2fa(String code) { + return set2fa(code, null); + } + + /** + * Enables two-factor authentication + * Mobile API only + * + * @param code the six digits non-null numeric code + * @param email the nullable recovery email + * @return a future + */ + public CompletableFuture enable2fa(String code, String email) { + return set2fa(code, email); + } + + /** + * Disables two-factor authentication + * Mobile API only + * + * @return a future + */ + public CompletableFuture disable2fa() { + return set2fa(null, null); + } + + private CompletableFuture set2fa(String code, String email) { + Validate.isTrue(store().clientType() == ClientType.MOBILE, "2FA is only available for the mobile api"); + Validate.isTrue(code == null || (code.matches("^[0-9]*$") && code.length() == 6), + "Invalid 2fa code: expected a numeric six digits string"); + Validate.isTrue(email == null || isValidEmail(email), + "Invalid email: %s", email); + var body = new ArrayList(); + body.add(Node.of("code", Objects.requireNonNullElse(code, "").getBytes(StandardCharsets.UTF_8))); + if (code != null && email != null) { + body.add(Node.of("email", email.getBytes(StandardCharsets.UTF_8))); + } + return socketHandler.sendQuery("set", "urn:xmpp:whatsapp:account", Node.of("2fa", body)) + .thenApplyAsync(result -> !result.hasNode("error")); + } + + /** + * Starts a call with a contact + * Mobile API only + * + * @param contact the non-null contact + * @return a future + */ + public CompletableFuture startCall(JidProvider contact) { + Validate.isTrue(store().clientType() == ClientType.MOBILE, "Calling is only available for the mobile api"); + return socketHandler.querySessions(contact.toJid()) + .thenComposeAsync(ignored -> sendCallMessage(contact)); + } + + private CompletableFuture sendCallMessage(JidProvider provider) { + var callId = ChatMessageKey.randomId(); + var audioStream = Node.of("audio", Map.of("rate", 8000, "enc", "opus")); + var audioStreamTwo = Node.of("audio", Map.of("rate", 16000, "enc", "opus")); + var net = Node.of("net", Map.of("medium", 3)); + var encopt = Node.of("encopt", Map.of("keygen", 2)); + var enc = createCallNode(provider); + var capability = Node.of("capability", Map.of("ver", 1), HexFormat.of().parseHex("0104ff09c4fa")); + var callCreator = "%s:0@s.whatsapp.net".formatted(jidOrThrowError().user()); + var offer = Node.of("offer", + Map.of("call-creator", callCreator, "call-id", callId), + audioStream, audioStreamTwo, net, capability, encopt, enc); + return socketHandler.send(Node.of("call", Map.of("to", provider.toJid()), offer)) + .thenApply(result -> onCallSent(provider, callId, result)); + } + + private Call onCallSent(JidProvider provider, String callId, Node result) { + var call = new Call(provider.toJid(), jidOrThrowError(), callId, Clock.nowSeconds(), false, CallStatus.RINGING, false); + store().addCall(call); + socketHandler.onCall(call); + return call; + } + + private Node createCallNode(JidProvider provider) { + var call = new CallMessageBuilder() + .key(SignalKeyPair.random().publicKey()) + .build(); + var message = MessageContainer.of(call); + var cipher = new SessionCipher(provider.toJid().toSignalAddress(), keys()); + var encodedMessage = Bytes.messageToBytes(message); + var cipheredMessage = cipher.encrypt(encodedMessage); + return Node.of("enc", Map.of("v", 2, "type", cipheredMessage.type()), cipheredMessage.message()); + } + + + /** + * Rejects an incoming call or stops an active call + * Mobile API only + * + * @param callId the non-null id of the call to reject + * @return a future + */ + public CompletableFuture stopCall(String callId) { + Validate.isTrue(store().clientType() == ClientType.MOBILE, "Calling is only available for the mobile api"); + return store().findCallById(callId) + .map(this::stopCall) + .orElseGet(() -> CompletableFuture.completedFuture(false)); + } + + /** + * Rejects an incoming call or stops an active call + * Mobile API only + * + * @param call the non-null call to reject + * @return a future + */ + public CompletableFuture stopCall(Call call) { + Validate.isTrue(store().clientType() == ClientType.MOBILE, "Calling is only available for the mobile api"); + var callCreator = "%s.%s:%s@s.whatsapp.net".formatted(call.caller().user(), call.caller().device(), call.caller().device()); + if (Objects.equals(call.caller().user(), jidOrThrowError().user())) { + var rejectNode = Node.of("terminate", Map.of("reason", "timeout", "call-id", call.id(), "call-creator", callCreator)); + var body = Node.of("call", Map.of("to", call.chat()), rejectNode); + return socketHandler.send(body) + .thenApplyAsync(result -> !result.hasNode("error")); + } + + var rejectNode = Node.of("reject", Map.of("call-id", call.id(), "call-creator", callCreator, "count", 0)); + var body = Node.of("call", Map.of("from", socketHandler.store().jid(), "to", call.caller()), rejectNode); + return socketHandler.send(body) + .thenApplyAsync(result -> !result.hasNode("error")); + } + + + /** + * Queries a list of fifty recommended newsletters by country + * + * @param countryCode the non-null country code + * @return a list of recommended newsletters, if the feature is available + */ + public CompletableFuture> queryRecommendedNewsletters(String countryCode) { + return queryRecommendedNewsletters(countryCode, 50); + } + + + /** + * Queries a list of recommended newsletters by country + * + * @param countryCode the non-null country code + * @param limit how many entries should be returned + * @return a list of recommended newsletters, if the feature is available + */ + public CompletableFuture> queryRecommendedNewsletters(String countryCode, int limit) { + var filters = new RecommendedNewslettersRequest.Filters(List.of(countryCode)); + var input = new RecommendedNewslettersRequest.Input("RECOMMENDED", filters, limit); + var variable = new RecommendedNewslettersRequest.Variable(input); + var query = new RecommendedNewslettersRequest(variable); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "6190824427689257"), Json.writeValueAsBytes(query))) + .thenApplyAsync(this::parseRecommendedNewsletters); + } + + private Optional parseRecommendedNewsletters(Node response) { + return response.findNode("result") + .flatMap(Node::contentAsString) + .flatMap(RecommendedNewslettersResponse::ofJson); + } + + /** + * Queries any number of messages from a newsletter + * + * @param newsletterJid the non-null jid of the newsletter + * @param count how many messages should be queried + * @return a future + */ + public CompletableFuture queryNewsletterMessages(JidProvider newsletterJid, int count) { + return socketHandler.queryNewsletterMessages(newsletterJid, count); + } + + /** + * Subscribes to a public newsletter's event stream of reactions + * + * @param channel the non-null channel + * @return the time, in minutes, during which updates will be sent + */ + public CompletableFuture subscribeToNewsletterReactions(JidProvider channel) { + return socketHandler.subscribeToNewsletterReactions(channel); + } + + /** + * Creates a newsletter + * + * @param name the non-null name of the newsletter + * @return a future + */ + public CompletableFuture> createNewsletter(String name) { + return createNewsletter(name, null, null); + } + + /** + * Creates newsletter channel + * + * @param name the non-null name of the newsletter + * @param description the nullable description of the newsletter + * @return a future + */ + public CompletableFuture> createNewsletter(String name, String description) { + return createNewsletter(name, description, null); + } + + /** + * Creates a newsletter + * + * @param name the non-null name of the newsletter + * @param description the nullable description of the newsletter + * @param picture the nullable profile picture of the newsletter + * @return a future + */ + public CompletableFuture> createNewsletter(String name, String description, byte[] picture) { + var input = new CreateNewsletterRequest.NewsletterInput(name, description, picture != null ? Base64.getEncoder().encodeToString(picture) : null); + var variable = new CreateNewsletterRequest.Variable(input); + var request = new CreateNewsletterRequest(variable); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "6996806640408138"), Json.writeValueAsBytes(request))) + .thenApplyAsync(this::parseNewsletterCreation) + .thenComposeAsync(this::onNewsletterCreation); + } + + private Optional parseNewsletterCreation(Node response) { + return response.findNode("result") + .flatMap(Node::contentAsString) + .flatMap(NewsletterResponse::ofJson) + .map(NewsletterResponse::newsletter); + } + + @SuppressWarnings("OptionalUsedAsFieldOrParameterType") + private CompletableFuture> onNewsletterCreation(Optional result) { + if (result.isEmpty()) { + return CompletableFuture.completedFuture(result); + } + + return subscribeToNewsletterReactions(result.get().jid()) + .thenApply(ignored -> result); + } + + /** + * Changes the description of a newsletter + * + * @param newsletter the non-null target newsletter + * @param description the nullable new description + * @return a future + */ + public CompletableFuture changeNewsletterDescription(JidProvider newsletter, String description) { + var safeDescription = Objects.requireNonNullElse(description, ""); + var payload = new UpdatePayload(safeDescription); + var body = new UpdateNewsletterRequest.Variable(newsletter.toJid(), payload); + var request = new UpdateNewsletterRequest(body); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "7150902998257522"), Json.writeValueAsBytes(request))) + .thenRun(() -> {}); + } + + /** + * Joins a newsletter + * + * @param newsletter a non-null newsletter + * @return a future + */ + public CompletableFuture joinNewsletter(JidProvider newsletter) { + var body = new JoinNewsletterRequest.Variable(newsletter.toJid()); + var request = new JoinNewsletterRequest(body); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "9926858900719341"), Json.writeValueAsBytes(request))) + .thenRun(() -> {}); + } + + /** + * Leaves a newsletter + * + * @param newsletter a non-null newsletter + * @return a future + */ + public CompletableFuture leaveNewsletter(JidProvider newsletter) { + var body = new LeaveNewsletterRequest.Variable(newsletter.toJid()); + var request = new LeaveNewsletterRequest(body); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "6392786840836363"), Json.writeValueAsBytes(request))) + .thenRun(() -> {}); + } + + /** + * Queries the number of people subscribed to a newsletter + * + * @param newsletterJid the id of the newsletter + * @return a CompletableFuture + */ + public CompletableFuture queryNewsletterSubscribers(JidProvider newsletterJid) { + var newsletterRole = store().findNewsletterByJid(newsletterJid) + .flatMap(Newsletter::viewerMetadata) + .map(NewsletterViewerMetadata::role) + .orElse(NewsletterViewerRole.GUEST); + var input = new NewsletterSubscribersRequest.Input(newsletterJid.toJid(), "JID", newsletterRole.name()); + var body = new NewsletterSubscribersRequest.Variable(input); + var request = new NewsletterSubscribersRequest(body); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "7272540469429201"), Json.writeValueAsBytes(request))) + .thenApply(this::parseNewsletterSubscribers); + } + + private long parseNewsletterSubscribers(Node response) { + return response.findNode("result") + .flatMap(Node::contentAsString) + .flatMap(NewsletterSubscribersResponse::ofJson) + .map(NewsletterSubscribersResponse::subscribersCount) + .orElse(0L); + } + + /** + * Sends an invitation to each jid provided to become an admin in the newsletter + * + * @param newsletterJid the id of the newsletter + * @param admins the new admins + * @return a CompletableFuture + */ + public CompletableFuture inviteNewsletterAdmins(JidProvider newsletterJid, JidProvider... admins) { + return inviteNewsletterAdmins(newsletterJid, null, admins); + } + + /** + * Sends an invitation to each jid provided to become an admin in the newsletter + * + * @param newsletterJid the id of the newsletter + * @param inviteCaption the nullable caption of the invitation + * @param admins the new admins + * @return a CompletableFuture + */ + public CompletableFuture inviteNewsletterAdmins(JidProvider newsletterJid, String inviteCaption, JidProvider... admins) { + var messageFutures = Arrays.stream(admins) + .map(admin -> createNewsletterAdminInvite(newsletterJid, inviteCaption, admin)) + .toArray(CompletableFuture[]::new); + return CompletableFuture.allOf(messageFutures); + } + + private CompletableFuture createNewsletterAdminInvite(JidProvider newsletterJid, String inviteCaption, JidProvider admin) { + return getContactData(admin).thenComposeAsync(results -> { + var recipient = results.getFirst() + .findNode("lid") + .flatMap(result -> result.attributes().getOptionalJid("val")) + .map(jid -> jid.withServer(JidServer.LID).toSimpleJid()) + .orElse(admin.toJid()); + var request = new CreateAdminInviteNewsletterRequest(new CreateAdminInviteNewsletterRequest.Variable(newsletterJid.toJid(), recipient)); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "6826078034173770"), Json.writeValueAsBytes(request))) + .thenApplyAsync(this::parseNewsletterAdminInviteExpiration) + .thenComposeAsync(expirationTimestamp -> sendNewsletterInviteMessage(newsletterJid, inviteCaption, expirationTimestamp, admin)); + }); + } + + private CompletableFuture> getContactData(JidProvider recipient) { + var businessNode = Node.of("business", Node.of("verified_name"), Node.of("profile", Map.of("v", 372))); + var contactNode = Node.of("contact"); + var lidNode = Node.of("lid"); + var userNode = Node.of("user", Node.of("contact", recipient.toJid().toPhoneNumber().getBytes(StandardCharsets.UTF_8))); + return socketHandler.sendInteractiveQuery(List.of(businessNode, contactNode, lidNode), List.of(userNode), List.of()); + } + + private long parseNewsletterAdminInviteExpiration(Node result) { + var payload = result.findNode("result") + .flatMap(Node::contentAsString); + return payload.flatMap(CreateAdminInviteNewsletterResponse::ofJson) + .map(CreateAdminInviteNewsletterResponse::mute) + .orElseThrow(() -> new IllegalArgumentException("Cannot create invite: " + payload.orElse("unknown"))); + } + + private CompletableFuture sendNewsletterInviteMessage(JidProvider newsletterJid, String inviteCaption, long expirationTimestamp, JidProvider admin) { + var newsletterName = store().findNewsletterByJid(newsletterJid.toJid()) + .map(Newsletter::metadata) + .flatMap(NewsletterMetadata::name) + .map(NewsletterName::text) + .orElse(null); + var message = new NewsletterAdminInviteMessageBuilder() + .newsletterJid(newsletterJid.toJid()) + .newsletterName(newsletterName) + .inviteExpirationTimestampSeconds(expirationTimestamp) + .caption(Objects.requireNonNullElse(inviteCaption, "Accept this invitation to be an admin for my WhatsApp channel")) + .build(); + return sendChatMessage(admin, MessageContainer.of(message), false); + } + + /** + * Revokes an invitation to become an admin in a newsletter + * + * @param newsletterJid the id of the newsletter + * @param admin the non-null user that received the invite previously + * @return a CompletableFuture + */ + public CompletableFuture revokeNewsletterAdminInvite(JidProvider newsletterJid, JidProvider admin) { + return getContactData(admin).thenCompose(results -> { + var recipient = results.getFirst() + .findNode("lid") + .flatMap(result -> result.attributes().getOptionalJid("val")) + .map(jid -> jid.withServer(JidServer.LID).toSimpleJid()) + .orElse(admin.toJid()); + var request = new RevokeAdminInviteNewsletterRequest(new RevokeAdminInviteNewsletterRequest.Variable(newsletterJid.toJid(), recipient)); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "6111171595650958"), Json.writeValueAsBytes(request))) + .thenApplyAsync(this::hasRevokedNewsletterAdminInvite); + }); + } + + private boolean hasRevokedNewsletterAdminInvite(Node result) { + return result.findNode("result") + .flatMap(Node::contentAsString) + .flatMap(RevokeAdminInviteNewsletterResponse::ofJson) + .isPresent(); + } + + /** + * Accepts an invitation to become an admin in a newsletter + * + * @param newsletterJid the id of the newsletter + * @return a CompletableFuture + */ + public CompletableFuture acceptNewsletterAdminInvite(JidProvider newsletterJid) { + var request = new AcceptAdminInviteNewsletterRequest(new AcceptAdminInviteNewsletterRequest.Variable(newsletterJid.toJid())); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "7292354640794756"), Json.writeValueAsBytes(request))) + .thenApplyAsync(this::hasAcceptedNewsletterAdminInvite) + .thenComposeAsync(result -> { + if(result.isEmpty()) { + return CompletableFuture.completedFuture(false); + } + + return queryNewsletter(result.get(), NewsletterViewerRole.ADMIN).thenApplyAsync(newsletter -> { + if(newsletter.isEmpty()) { + return false; + } + + store().addNewsletter(newsletter.get()); + return true; + }); + }); + } + + private Optional hasAcceptedNewsletterAdminInvite(Node result) { + return result.findNode("result") + .flatMap(Node::contentAsString) + .flatMap(AcceptAdminInviteNewsletterResponse::ofJson) + .map(AcceptAdminInviteNewsletterResponse::jid); + } + + /** + * Queries a newsletter + * + * @param newsletterJid the non-null jid of the newsletter + * @param role the non-null role of the user executing the query + * @return a future + */ + public CompletableFuture> queryNewsletter(Jid newsletterJid, NewsletterViewerRole role) { + var key = new QueryNewsletterRequest.Input(newsletterJid, "JID", role); + var request = new QueryNewsletterRequest(new QueryNewsletterRequest.Variable(key, true, true, true)); + return socketHandler.sendQuery("get", "w:mex", Node.of("query", Map.of("query_id", "6620195908089573"), Json.writeValueAsBytes(request))) + .thenApplyAsync(this::parseNewsletterQuery); + } + + private Optional parseNewsletterQuery(Node response) { + return response.findNode("result") + .flatMap(Node::contentAsString) + .flatMap(NewsletterResponse::ofJson) + .map(NewsletterResponse::newsletter); + } + + /** + * Registers a listener + * + * @param listener the listener to register + * @return the same instance + */ + public Whatsapp addListener(Listener listener) { + store().addListener(listener); + return this; + } + + /** + * Unregisters a listener + * + * @param listener the listener to unregister + * @return the same instance + */ + public Whatsapp removeListener(Listener listener) { + store().removeListener(listener); + return this; + } + + /** + * Registers an action listener + * + * @param onAction the listener to register + * @return the same instance + */ + public Whatsapp addActionListener(OnAction onAction) { + return addListener(onAction); + } + + /** + * Registers a chat recent messages listener + * + * @param onChatRecentMessages the listener to register + * @return the same instance + */ + public Whatsapp addChatMessagesSyncListener(OnChatMessagesSync onChatRecentMessages) { + return addListener(onChatRecentMessages); + } + + /** + * Registers a chats listener + * + * @param onChats the listener to register + * @return the same instance + */ + public Whatsapp addChatsListener(OnChats onChats) { + return addListener(onChats); + } + + /** + * Registers a chats listener + * + * @param onChats the listener to register + * @return the same instance + */ + public Whatsapp addChatsListener(OnWhatsappChats onChats) { + return addListener(onChats); + } + + /** + * Registers a newsletters listener + * + * @param onNewsletters the listener to register + * @return the same instance + */ + public Whatsapp addNewslettersListener(OnNewsletters onNewsletters) { + return addListener(onNewsletters); + } + + /** + * Registers a newsletters listener + * + * @param onNewsletters the listener to register + * @return the same instance + */ + public Whatsapp addNewslettersListener(OnWhatsappNewsletters onNewsletters) { + return addListener(onNewsletters); + } + + + /** + * Registers a contact presence listener + * + * @param onContactPresence the listener to register + * @return the same instance + */ + public Whatsapp addContactPresenceListener(OnContactPresence onContactPresence) { + return addListener(onContactPresence); + } + + /** + * Registers a contacts listener + * + * @param onContacts the listener to register + * @return the same instance + */ + public Whatsapp addContactsListener(OnContacts onContacts) { + return addListener(onContacts); + } + + /** + * Registers a message status listener + * + * @param onAnyMessageStatus the listener to register + * @return the same instance + */ + public Whatsapp addMessageStatusListener(OnMessageStatus onAnyMessageStatus) { + return addListener(onAnyMessageStatus); + } + + /** + * Registers a disconnected listener + * + * @param onDisconnected the listener to register + * @return the same instance + */ + public Whatsapp addDisconnectedListener(OnDisconnected onDisconnected) { + return addListener(onDisconnected); + } + + /** + * Registers a features listener + * + * @param onFeatures the listener to register + * @return the same instance + */ + public Whatsapp addFeaturesListener(OnFeatures onFeatures) { + return addListener(onFeatures); + } + + /** + * Registers a logged in listener + * + * @param onLoggedIn the listener to register + * @return the same instance + */ + public Whatsapp addLoggedInListener(OnLoggedIn onLoggedIn) { + return addListener(onLoggedIn); + } + + /** + * Registers a message deleted listener + * + * @param onMessageDeleted the listener to register + * @return the same instance + */ + public Whatsapp addMessageDeletedListener(OnMessageDeleted onMessageDeleted) { + return addListener(onMessageDeleted); + } + + /** + * Registers a metadata listener + * + * @param onMetadata the listener to register + * @return the same instance + */ + public Whatsapp addMetadataListener(OnMetadata onMetadata) { + return addListener(onMetadata); + } + + /** + * Registers a new contact listener + * + * @param onNewContact the listener to register + * @return the same instance + */ + public Whatsapp addNewContactListener(OnNewContact onNewContact) { + return addListener(onNewContact); + } + + /** + * Registers a new message listener + * + * @param onNewMessage the listener to register + * @return the same instance + */ + public Whatsapp addNewChatMessageListener(OnNewMessage onNewMessage) { + return addListener(onNewMessage); + } + + /** + * Registers a new status listener + * + * @param onNewMediaStatus the listener to register + * @return the same instance + */ + public Whatsapp addNewStatusListener(OnNewStatus onNewMediaStatus) { + return addListener(onNewMediaStatus); + } + + /** + * Registers a received node listener + * + * @param onNodeReceived the listener to register + * @return the same instance + */ + public Whatsapp addNodeReceivedListener(OnNodeReceived onNodeReceived) { + return addListener(onNodeReceived); + } + + /** + * Registers a sent node listener + * + * @param onNodeSent the listener to register + * @return the same instance + */ + public Whatsapp addNodeSentListener(OnNodeSent onNodeSent) { + return addListener(onNodeSent); + } + + /** + * Registers a setting listener + * + * @param onSetting the listener to register + * @return the same instance + */ + public Whatsapp addSettingListener(OnSetting onSetting) { + return addListener(onSetting); + } + + /** + * Registers a status listener + * + * @param onMediaStatus the listener to register + * @return the same instance + */ + public Whatsapp addMediaStatusListener(OnStatus onMediaStatus) { + return addListener(onMediaStatus); + } + + /** + * Registers an event listener + * + * @param onSocketEvent the listener to register + * @return the same instance + */ + public Whatsapp addSocketEventListener(OnSocketEvent onSocketEvent) { + return addListener(onSocketEvent); + } + + /** + * Registers an action listener + * + * @param onAction the listener to register + * @return the same instance + */ + public Whatsapp addActionListener(OnWhatsappAction onAction) { + return addListener(onAction); + } + + /** + * Registers a sync progress listener + * + * @param onSyncProgress the listener to register + * @return the same instance + */ + public Whatsapp addHistorySyncProgressListener(OnHistorySyncProgress onSyncProgress) { + return addListener(onSyncProgress); + } + + /** + * Registers a chat recent messages listener + * + * @param onChatRecentMessages the listener to register + * @return the same instance + */ + public Whatsapp addChatMessagesSyncListener(OnWhatsappChatMessagesSync onChatRecentMessages) { + return addListener(onChatRecentMessages); + } + + /** + * Registers a contact presence listener + * + * @param onContactPresence the listener to register + * @return the same instance + */ + public Whatsapp addContactPresenceListener(OnWhatsappContactPresence onContactPresence) { + return addListener(onContactPresence); + } + + /** + * Registers a contacts listener + * + * @param onContacts the listener to register + * @return the same instance + */ + public Whatsapp addContactsListener(OnWhatsappContacts onContacts) { + return addListener(onContacts); + } + + /** + * Registers a message status listener + * + * @param onMessageStatus the listener to register + * @return the same instance + */ + public Whatsapp addMessageStatusListener(OnWhatsappMessageStatus onMessageStatus) { + return addListener(onMessageStatus); + } + + /** + * Registers a disconnected listener + * + * @param onDisconnected the listener to register + * @return the same instance + */ + public Whatsapp addDisconnectedListener(OnWhatsappDisconnected onDisconnected) { + return addListener(onDisconnected); + } + + /** + * Registers a features listener + * + * @param onFeatures the listener to register + * @return the same instance + */ + public Whatsapp addFeaturesListener(OnWhatsappFeatures onFeatures) { + return addListener(onFeatures); + } + + /** + * Registers a logged in listener + * + * @param onLoggedIn the listener to register + * @return the same instance + */ + public Whatsapp addLoggedInListener(OnWhatsappLoggedIn onLoggedIn) { + return addListener(onLoggedIn); + } + + /** + * Registers a message deleted listener + * + * @param onMessageDeleted the listener to register + * @return the same instance + */ + public Whatsapp addMessageDeletedListener(OnWhatsappMessageDeleted onMessageDeleted) { + return addListener(onMessageDeleted); + } + + /** + * Registers a metadata listener + * + * @param onMetadata the listener to register + * @return the same instance + */ + public Whatsapp addMetadataListener(OnWhatsappMetadata onMetadata) { + return addListener(onMetadata); + } + + /** + * Registers a new message listener + * + * @param onNewMessage the listener to register + * @return the same instance + */ + public Whatsapp addNewChatMessageListener(OnWhatsappNewMessage onNewMessage) { + return addListener(onNewMessage); + } + + /** + * Registers a new status listener + * + * @param onNewStatus the listener to register + * @return the same instance + */ + public Whatsapp addNewStatusListener(OnWhatsappNewStatus onNewStatus) { + return addListener(onNewStatus); + } + + /** + * Registers a received node listener + * + * @param onNodeReceived the listener to register + * @return the same instance + */ + public Whatsapp addNodeReceivedListener(OnWhatsappNodeReceived onNodeReceived) { + return addListener(onNodeReceived); + } + + /** + * Registers a sent node listener + * + * @param onNodeSent the listener to register + * @return the same instance + */ + public Whatsapp addNodeSentListener(OnWhatsappNodeSent onNodeSent) { + return addListener(onNodeSent); + } + + /** + * Registers a setting listener + * + * @param onSetting the listener to register + * @return the same instance + */ + public Whatsapp addSettingListener(OnWhatsappSetting onSetting) { + return addListener(onSetting); + } + + /** + * Registers a status listener + * + * @param onStatus the listener to register + * @return the same instance + */ + public Whatsapp addMediaStatusListener(OnWhatsappMediaStatus onStatus) { + return addListener(onStatus); + } + + /** + * Registers an event listener + * + * @param onSocketEvent the listener to register + * @return the same instance + */ + public Whatsapp addSocketEventListener(OnWhatsappSocketEvent onSocketEvent) { + return addListener(onSocketEvent); + } + + /** + * Registers a sync progress listener + * + * @param onSyncProgress the listener to register + * @return the same instance + */ + public Whatsapp addHistorySyncProgressListener(OnWhatsappHistorySyncProgress onSyncProgress) { + return addListener(onSyncProgress); + } + + /** + * Registers a message reply listener + * + * @param onMessageReply the listener to register + * @return the same instance + */ + public Whatsapp addMessageReplyListener(OnWhatsappMessageReply onMessageReply) { + return addListener(onMessageReply); + } + + /** + * Registers a message reply listener for a specific message + * + * @param info the non-null target message + * @param onMessageReply the non-null listener + */ + public Whatsapp addMessageReplyListener(ChatMessageInfo info, OnMessageReply onMessageReply) { + return addMessageReplyListener(info.id(), onMessageReply); + } + + /** + * Registers a message reply listener + * + * @param onMessageReply the listener to register + * @return the same instance + */ + public Whatsapp addMessageReplyListener(OnMessageReply onMessageReply) { + return addListener(onMessageReply); + } + + /** + * Registers a message reply listener for a specific message + * + * @param info the non-null target message + * @param onMessageReply the non-null listener + */ + public Whatsapp addMessageReplyListener(ChatMessageInfo info, OnWhatsappMessageReply onMessageReply) { + return addMessageReplyListener(info.id(), onMessageReply); + } + + /** + * Registers a message reply listener for a specific message + * + * @param id the non-null id of the target message + * @param onMessageReply the non-null listener + */ + public Whatsapp addMessageReplyListener(String id, OnMessageReply onMessageReply) { + return addMessageReplyListener((info, quoted) -> { + if (!info.id().equals(id)) { + return; + } + + onMessageReply.onMessageReply(info, quoted); + }); + } + + /** + * Registers a message reply listener for a specific message + * + * @param id the non-null id of the target message + * @param onMessageReply the non-null listener + */ + public Whatsapp addMessageReplyListener(String id, OnWhatsappMessageReply onMessageReply) { + return addMessageReplyListener(((whatsapp, info, quoted) -> { + if (!info.id().equals(id)) { + return; + } + + onMessageReply.onMessageReply(whatsapp, info, quoted); + })); + } + + /** + * Registers a name change listener + * + * @param onUserNameChanged the non-null listener + */ + public Whatsapp addNameChangedListener(OnUserNameChanged onUserNameChanged) { + return addListener(onUserNameChanged); + } + + /** + * Registers a name change listener + * + * @param onNameChange the non-null listener + */ + public Whatsapp addNameChangedListener(OnWhatsappNameChanged onNameChange) { + return addListener(onNameChange); + } + + /** + * Registers a status change listener + * + * @param onUserAboutChanged the non-null listener + */ + public Whatsapp addAboutChangedListener(OnUserAboutChanged onUserAboutChanged) { + return addListener(onUserAboutChanged); + } + + /** + * Registers a status change listener + * + * @param onUserStatusChange the non-null listener + */ + public Whatsapp addAboutChangedListener(OnWhatsappAboutChanged onUserStatusChange) { + return addListener(onUserStatusChange); + } + + /** + * Registers a picture change listener + * + * @param onProfilePictureChanged the non-null listener + */ + public Whatsapp addUserPictureChangedListener(OnProfilePictureChanged onProfilePictureChanged) { + return addListener(onProfilePictureChanged); + } + + /** + * Registers a picture change listener + * + * @param onUserPictureChange the non-null listener + */ + public Whatsapp addUserPictureChangedListener(OnWhatsappProfilePictureChanged onUserPictureChange) { + return addListener(onUserPictureChange); + } + + /** + * Registers a profile picture listener + * + * @param onContactPictureChanged the non-null listener + */ + public Whatsapp addContactPictureChangedListener(OnContactPictureChanged onContactPictureChanged) { + return addListener(onContactPictureChanged); + } + + /** + * Registers a profile picture listener + * + * @param onProfilePictureChange the non-null listener + */ + public Whatsapp addContactPictureChangedListener(OnWhatsappContactPictureChanged onProfilePictureChange) { + return addListener(onProfilePictureChange); + } + + /** + * Registers a group picture listener + * + * @param onGroupPictureChange the non-null listener + */ + public Whatsapp addGroupPictureChangedListener(OnGroupPictureChange onGroupPictureChange) { + return addListener(onGroupPictureChange); + } + + /** + * Registers a group picture listener + * + * @param onGroupPictureChange the non-null listener + */ + public Whatsapp addGroupPictureChangedListener(OnWhatsappGroupPictureChange onGroupPictureChange) { + return addListener(onGroupPictureChange); + } + + /** + * Registers a contact blocked listener + * + * @param onContactBlocked the non-null listener + */ + public Whatsapp addContactBlockedListener(OnContactBlocked onContactBlocked) { + return addListener(onContactBlocked); + } + + /** + * Registers a contact blocked listener + * + * @param onContactBlocked the non-null listener + */ + public Whatsapp addContactBlockedListener(OnWhatsappContactBlocked onContactBlocked) { + return addListener(onContactBlocked); + } + + /** + * Registers a privacy setting changed listener + * + * @param onPrivacySettingChanged the listener to register + * @return the same instance + */ + public Whatsapp addPrivacySettingChangedListener(OnPrivacySettingChanged onPrivacySettingChanged) { + return addListener(onPrivacySettingChanged); + } + + + /** + * Registers a privacy setting changed listener + * + * @param onWhatsappPrivacySettingChanged the listener to register + * @return the same instance + */ + public Whatsapp addPrivacySettingChangedListener(OnWhatsappPrivacySettingChanged onWhatsappPrivacySettingChanged) { + return addListener(onWhatsappPrivacySettingChanged); + } + + /** + * Registers a companion devices changed listener + * + * @param onLinkedDevices the listener to register + * @return the same instance + */ + public Whatsapp addLinkedDevicesListener(OnLinkedDevices onLinkedDevices) { + return addListener(onLinkedDevices); + } + + /** + * Registers a companion devices changed listener + * + * @param onWhatsappLinkedDevices the listener to register + * @return the same instance + */ + public Whatsapp addLinkedDevicesListener(OnWhatsappLinkedDevices onWhatsappLinkedDevices) { + return addListener(onWhatsappLinkedDevices); + } + + /** + * Registers a registration code listener for the mobile api + * + * @param onRegistrationCode the listener to register + * @return the same instance + */ + public Whatsapp addRegistrationCodeListener(OnRegistrationCode onRegistrationCode) { + return addListener(onRegistrationCode); + } + + /** + * Registers a registration code listener for the mobile api + * + * @param onWhatsappRegistrationCode the listener to register + * @return the same instance + */ + public Whatsapp addRegistrationCodeListener(OnWhatsappRegistrationCode onWhatsappRegistrationCode) { + return addListener(onWhatsappRegistrationCode); + } + + /** + * Registers a call listener + * + * @param onCall the listener to register + * @return the same instance + */ + public Whatsapp addCallListener(OnCall onCall) { + return addListener(onCall); + } + + /** + * Registers a call listener + * + * @param onWhatsappCall the listener to register + * @return the same instance + */ + public Whatsapp addCallListener(OnWhatsappCall onWhatsappCall) { + return addListener(onWhatsappCall); + } + + private Jid jidOrThrowError() { + return store().jid() + .orElseThrow(() -> new IllegalStateException("The session isn't connected")); + } +} diff --git a/src/main/java/it/auties/whatsapp/api/WhatsappCustomBuilder.java b/src/main/java/it/auties/whatsapp/api/WhatsappCustomBuilder.java new file mode 100644 index 000000000..f6191c009 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/api/WhatsappCustomBuilder.java @@ -0,0 +1,61 @@ +package it.auties.whatsapp.api; + +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.util.Validate; + +import java.util.Objects; + +public class WhatsappCustomBuilder { + private Store store; + private Keys keys; + private ErrorHandler errorHandler; + private WebVerificationHandler webVerificationHandler; + + WhatsappCustomBuilder() { + + } + + public WhatsappCustomBuilder store(Store store) { + this.store = store; + return this; + } + + public WhatsappCustomBuilder keys(Keys keys) { + this.keys = keys; + return this; + } + + public WhatsappCustomBuilder errorHandler(ErrorHandler errorHandler) { + this.errorHandler = errorHandler; + return this; + } + + public WhatsappCustomBuilder webVerificationSupport(WebVerificationHandler webVerificationHandler) { + this.webVerificationHandler = webVerificationHandler; + return this; + } + + public Whatsapp build() { + Validate.isTrue(Objects.equals(store.uuid(), keys.uuid()), "UUID mismatch: %s != %s", store.uuid(), keys.uuid()); + var knownInstance = Whatsapp.getInstanceByUuid(store.uuid()); + if (knownInstance.isPresent()) { + return knownInstance.get(); + } + + var checkedSupport = getWebVerificationMethod(store, keys, webVerificationHandler); + return new Whatsapp(store, keys, errorHandler, checkedSupport); + } + + private static WebVerificationHandler getWebVerificationMethod(Store store, Keys keys, WebVerificationHandler webVerificationHandler) { + if (store.clientType() != ClientType.WEB) { + return null; + } + + if (!keys.registered() && webVerificationHandler == null) { + return QrHandler.toTerminal(); + } + + return webVerificationHandler; + } +} diff --git a/src/main/java/it/auties/whatsapp/binary/BinaryDecoder.java b/src/main/java/it/auties/whatsapp/binary/BinaryDecoder.java new file mode 100644 index 000000000..08dbc9bd5 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/binary/BinaryDecoder.java @@ -0,0 +1,164 @@ +package it.auties.whatsapp.binary; + +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.jid.JidServer; +import it.auties.whatsapp.model.node.Node; +import it.auties.whatsapp.util.Bytes; +import it.auties.whatsapp.util.Validate; + +import java.io.ByteArrayInputStream; +import java.io.DataInputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import static it.auties.whatsapp.binary.BinaryTag.*; + +public final class BinaryDecoder implements AutoCloseable { + private final DataInputStream dataInputStream; + private boolean closed; + public BinaryDecoder(byte[] buffer) { + var token = buffer[0] & 2; + if (token == 0) { + this.dataInputStream = new DataInputStream(new ByteArrayInputStream(buffer, 1, buffer.length - 1)); + }else { + this.dataInputStream = new DataInputStream(new ByteArrayInputStream(Bytes.decompress(buffer, 1, buffer.length - 1))); + } + } + + public Node decode() throws IOException { + if(closed) { + throw new IllegalStateException("The encoder is closed"); + } + + var token = dataInputStream.readUnsignedByte(); + var size = readSize(token); + Validate.isTrue(size != 0, "Cannot decode node with empty body"); + var description = readString(); + var attrs = readAttributes(size); + return size % 2 != 0 ? Node.of(description, attrs) : Node.of(description, attrs, read(false)); + } + + private String readString() throws IOException { + var read = read(true); + if (read instanceof String string) { + return string; + } + + throw new IllegalArgumentException("Strict decoding failed: expected string, got %s with type %s" + .formatted(read, read == null ? null : read.getClass().getName())); + } + + private List readList(int size) throws IOException { + var results = new ArrayList(); + for (int index = 0; index < size; index++) { + results.add(decode()); + } + + return results; + } + + private String readString(List permitted, int start, int end) throws IOException { + var string = new char[2 * end - start]; + for(var index = 0; index < string.length - 1; index += 2) { + readChar(permitted, string, index); + } + if (start != 0) { + string[string.length - 1] = permitted.get(dataInputStream.readUnsignedByte() >>> 4); + } + + return String.valueOf(string); + } + + private void readChar(List permitted, char[] string, int index) throws IOException { + var token = dataInputStream.readUnsignedByte(); + string[index] = permitted.get(token >>> 4); + string[index + 1] = permitted.get(15 & token); + } + + private Object read(boolean parseBytes) throws IOException { + var tag = dataInputStream.readUnsignedByte(); + return switch (of(tag)) { + case LIST_EMPTY -> null; + case COMPANION_JID -> readCompanionJid(); + case LIST_8 -> readList(dataInputStream.readUnsignedByte()); + case LIST_16 -> readList(dataInputStream.readUnsignedShort()); + case JID_PAIR -> readJidPair(); + case HEX_8 -> readHexString(); + case BINARY_8 -> readString(dataInputStream.readUnsignedByte(), parseBytes); + case BINARY_20 -> readString(readString20Length(), parseBytes); + case BINARY_32 -> readString(dataInputStream.readUnsignedShort(), parseBytes); + case NIBBLE_8 -> readNibble(); + default -> readStringFromToken(tag); + }; + } + + private int readString20Length() throws IOException { + return ((15 & dataInputStream.readUnsignedByte()) << 16) + + ((dataInputStream.readUnsignedByte()) << 8) + + (dataInputStream.readUnsignedByte()); + } + + private String readStringFromToken(int token) throws IOException { + if (token < DICTIONARY_0.data() || token > DICTIONARY_3.data()) { + return BinaryTokens.SINGLE_BYTE.get(token - 1); + } + + var delta = (BinaryTokens.DOUBLE_BYTE.size() / 4) * (token - DICTIONARY_0.data()); + return BinaryTokens.DOUBLE_BYTE.get(dataInputStream.readUnsignedByte() + delta); + } + + private String readNibble() throws IOException { + var number = dataInputStream.readUnsignedByte(); + return readString(BinaryTokens.NUMBERS, number >>> 7, 127 & number); + } + + private Object readString(int size, boolean parseBytes) throws IOException { + var data = new byte[size]; + dataInputStream.readFully(data); + return parseBytes ? new String(data, StandardCharsets.UTF_8) : data; + } + + private String readHexString() throws IOException { + var number = dataInputStream.readUnsignedByte(); + return readString(BinaryTokens.HEX, number >>> 7, 127 & number); + } + + private Jid readJidPair() throws IOException { + return switch (read(true)) { + case String encoded -> Jid.of(encoded, JidServer.of(readString())); + case null -> Jid.ofServer(JidServer.of(readString())); + default -> throw new RuntimeException("Invalid jid type"); + }; + } + + private Jid readCompanionJid() throws IOException { + var agent = dataInputStream.readUnsignedByte(); + var device = dataInputStream.readUnsignedByte(); + var user = readString(); + return new Jid(user, JidServer.WHATSAPP, device == 0 ? null : device, agent == 0 ? null : agent); + } + + private int readSize(int token) throws IOException { + return LIST_8.contentEquals(token) ? dataInputStream.readUnsignedByte() : dataInputStream.readUnsignedShort(); + } + + private Map readAttributes(int size) throws IOException { + var map = new HashMap(); + for (var pair = size - 1; pair > 1; pair -= 2) { + var key = readString(); + var value = read(true); + map.put(key, value); + } + return map; + } + + @Override + public void close() throws IOException { + this.closed = true; + dataInputStream.close(); + } +} diff --git a/src/main/java/it/auties/whatsapp/binary/BinaryEncoder.java b/src/main/java/it/auties/whatsapp/binary/BinaryEncoder.java new file mode 100644 index 000000000..3f13759e6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/binary/BinaryEncoder.java @@ -0,0 +1,269 @@ +package it.auties.whatsapp.binary; + +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.node.Node; + +import java.io.ByteArrayOutputStream; +import java.io.DataOutputStream; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.Collection; +import java.util.List; +import java.util.Objects; + +import static it.auties.whatsapp.binary.BinaryTag.*; + +public final class BinaryEncoder implements AutoCloseable { + private static final int UNSIGNED_BYTE_MAX_VALUE = 256; + private static final int UNSIGNED_SHORT_MAX_VALUE = 65536; + private static final int INT_20_MAX_VALUE = 1048576; + + private final ByteArrayOutputStream byteArrayOutputStream; + private final DataOutputStream dataOutputStream; + private final List singleByteTokens; + private final List doubleByteTokens; + private boolean closed; + + public BinaryEncoder() { + this(BinaryTokens.SINGLE_BYTE, BinaryTokens.DOUBLE_BYTE); + } + + public BinaryEncoder(List singleByteTokens, List doubleByteTokens) { + this.byteArrayOutputStream = new ByteArrayOutputStream(); + this.dataOutputStream = new DataOutputStream(byteArrayOutputStream); + this.singleByteTokens = singleByteTokens; + this.doubleByteTokens = doubleByteTokens; + } + + public byte[] encode(Node node) throws IOException { + if(closed) { + throw new IllegalStateException("The encoder is closed"); + } + + dataOutputStream.write(0); + writeNode(node); + return byteArrayOutputStream.toByteArray(); + } + + private void writeString(String input, BinaryTag token) throws IOException { + dataOutputStream.write(token.data()); + writeStringLength(input); + for (int charCode = 0, index = 0; index < input.length(); index++) { + var stringCodePoint = Character.codePointAt(input, index); + var binaryCodePoint = getStringCodePoint(token, stringCodePoint); + + if (index % 2 != 0) { + dataOutputStream.write(charCode |= binaryCodePoint); + continue; + } + + charCode = binaryCodePoint << 4; + if (index != input.length() - 1) { + continue; + } + + dataOutputStream.write(charCode |= 15); + } + } + + private int getStringCodePoint(BinaryTag token, int codePoint) { + if (codePoint >= 48 && codePoint <= 57) { + return codePoint - 48; + } + + if (token == NIBBLE_8 && codePoint == 45) { + return 10; + } + + if (token == NIBBLE_8 && codePoint == 46) { + return 11; + } + + if (token == HEX_8 && codePoint >= 65 && codePoint <= 70) { + return codePoint - 55; + } + + throw new IllegalArgumentException("Cannot parse codepoint %s with token %s".formatted(codePoint, token)); + } + + private void writeStringLength(String input) throws IOException { + var roundedLength = (int) Math.ceil(input.length() / 2F); + if (input.length() % 2 == 1) { + dataOutputStream.write(roundedLength | 128); + return; + } + + dataOutputStream.write(roundedLength); + } + + private void writeLong(long input) throws IOException { + if (input < UNSIGNED_BYTE_MAX_VALUE) { + dataOutputStream.write(BINARY_8.data()); + dataOutputStream.write((int) input); + return; + } + + if (input < INT_20_MAX_VALUE) { + dataOutputStream.write(BINARY_20.data()); + dataOutputStream.write((int) ((input >>> 16) & 255)); + dataOutputStream.write((int) ((input >>> 8) & 255)); + dataOutputStream.write((int) (255 & input)); + return; + } + + dataOutputStream.write(BINARY_32.data()); + dataOutputStream.writeLong(input); + } + + private void writeString(String input) throws IOException { + if (input.isEmpty()) { + dataOutputStream.write(BINARY_8.data()); + dataOutputStream.write(LIST_EMPTY.data()); + return; + } + + var tokenIndex = singleByteTokens.indexOf(input); + if (tokenIndex != -1) { + dataOutputStream.write(tokenIndex + 1); + return; + } + + if (writeDoubleByteString(input)) { + return; + } + + var length = length(input); + if (length < 128 && !BinaryTokens.anyMatch(input, BinaryTokens.NUMBERS_REGEX)) { + writeString(input, NIBBLE_8); + return; + } + + if (length < 128 && !BinaryTokens.anyMatch(input, BinaryTokens.HEX_REGEX)) { + writeString(input, HEX_8); + return; + } + + writeLong(length); + dataOutputStream.write(input.getBytes(StandardCharsets.UTF_8)); + } + + private boolean writeDoubleByteString(String input) throws IOException { + if (!doubleByteTokens.contains(input)) { + return false; + } + + var index = doubleByteTokens.indexOf(input); + dataOutputStream.write(doubleByteStringTag(index).data()); + dataOutputStream.write(index % (doubleByteTokens.size() / 4)); + return true; + } + + private BinaryTag doubleByteStringTag(int index) { + return switch (index / (doubleByteTokens.size() / 4)) { + case 0 -> DICTIONARY_0; + case 1 -> DICTIONARY_1; + case 2 -> DICTIONARY_2; + case 3 -> DICTIONARY_3; + default -> throw new IllegalArgumentException("Cannot find tag for quadrant %s".formatted(index)); + }; + } + + private void writeNode(Node input) throws IOException { + if (input.description().equals("0")) { + dataOutputStream.write(LIST_8.data()); + dataOutputStream.write(LIST_EMPTY.data()); + return; + } + + writeInt(input.size()); + writeString(input.description()); + writeAttributes(input); + if (input.hasContent()) { + write(input.content()); + } + } + + private void writeAttributes(Node input) throws IOException { + for (var entry : input.attributes().toMap().entrySet()) { + writeString(entry.getKey()); + write(entry.getValue()); + } + } + + private void writeInt(int size) throws IOException { + if (size < UNSIGNED_BYTE_MAX_VALUE) { + dataOutputStream.write(LIST_8.data()); + dataOutputStream.write(size); + return; + } + + if (size < UNSIGNED_SHORT_MAX_VALUE) { + dataOutputStream.write(LIST_16.data()); + dataOutputStream.writeShort(size); + return; + } + + throw new IllegalArgumentException("Cannot write int %s: overflow".formatted(size)); + } + + private void write(Object input) throws IOException { + switch (input) { + case null -> dataOutputStream.write(LIST_EMPTY.data()); + case String str -> writeString(str); + case Boolean bool -> writeString(Boolean.toString(bool)); + case Number number -> writeString(number.toString()); + case byte[] bytes -> writeBytes(bytes); + case Jid jid -> writeJid(jid); + case Collection collection -> writeList(collection); + case Enum serializable -> writeString(Objects.toString(serializable)); + case Node node -> + throw new IllegalArgumentException("Invalid payload type(nodes should be wrapped by a collection): %s".formatted(input)); + default -> + throw new IllegalArgumentException("Invalid payload type(%s): %s".formatted(input.getClass().getName(), input)); + } + } + + private void writeList(Collection collection) throws IOException { + writeInt(collection.size()); + for (var entry : collection) { + if (entry instanceof Node node) { + writeNode(node); + } + } + } + + private void writeBytes(byte[] bytes) throws IOException { + writeLong(bytes.length); + dataOutputStream.write(bytes); + } + + private void writeJid(Jid jid) throws IOException { + if (jid.isCompanion()) { + dataOutputStream.write(COMPANION_JID.data()); + dataOutputStream.write(jid.agent()); + dataOutputStream.write(jid.device()); + writeString(jid.user()); + return; + } + + dataOutputStream.write(JID_PAIR.data()); + if (jid.user() != null) { + writeString(jid.user()); + writeString(jid.server().address()); + return; + } + + dataOutputStream.write(LIST_EMPTY.data()); + writeString(jid.server().address()); + } + + private int length(String input) { + return input.getBytes(StandardCharsets.UTF_8).length; + } + + @Override + public void close() throws IOException { + this.closed = true; + dataOutputStream.close(); + } +} diff --git a/src/main/java/it/auties/whatsapp/binary/BinaryTag.java b/src/main/java/it/auties/whatsapp/binary/BinaryTag.java new file mode 100644 index 000000000..5aa3e2d61 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/binary/BinaryTag.java @@ -0,0 +1,42 @@ +package it.auties.whatsapp.binary; + +import java.util.Arrays; + +public enum BinaryTag { + UNKNOWN(-1), + LIST_EMPTY(0), + STREAM_END(2), + DICTIONARY_0(236), + DICTIONARY_1(237), + DICTIONARY_2(238), + DICTIONARY_3(239), + COMPANION_JID(247), + LIST_8(248), + LIST_16(249), + JID_PAIR(250), + HEX_8(251), + BINARY_8(252), + BINARY_20(253), + BINARY_32(254), + NIBBLE_8(255), + SINGLE_BYTE_MAX(256), + PACKED_MAX(254); + + private final int data; + + BinaryTag(int data) { + this.data = data; + } + + public static BinaryTag of(int data) { + return Arrays.stream(values()).filter(entry -> entry.data() == data).findAny().orElse(UNKNOWN); + } + + public boolean contentEquals(int number) { + return number == this.data(); + } + + public int data() { + return this.data; + } +} diff --git a/src/main/java/it/auties/whatsapp/binary/BinaryTokens.java b/src/main/java/it/auties/whatsapp/binary/BinaryTokens.java new file mode 100644 index 000000000..0f20c47ed --- /dev/null +++ b/src/main/java/it/auties/whatsapp/binary/BinaryTokens.java @@ -0,0 +1,1206 @@ +package it.auties.whatsapp.binary; + +import it.auties.whatsapp.model.companion.CompanionProperty; + +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.regex.Pattern; + +public final class BinaryTokens { + public static final List SINGLE_BYTE = List.of("xmlstreamstart", "xmlstreamend", "s.whatsapp.net", "type", "participant", "from", "receipt", "id", "notification", "disappearing_mode", "status", "jid", "broadcast", "user", "devices", "device_hash", "to", "offline", "message", "result", "class", "xmlns", "duration", "notify", "iq", "t", "ack", "g.us", "enc", "urn:xmpp:whatsapp:push", "presence", "config_value", "picture", "verified_name", "config_code", "key-index-list", "contact", "mediatype", "routing_info", "edge_routing", "get", "read", "urn:xmpp:ping", "fallback_hostname", "0", "chatstate", "business_hours_config", "unavailable", "download_buckets", "skmsg", "verified_level", "composing", "handshake", "device-list", "media", "text", "fallback_ip4", "media_conn", "device", "creation", "location", "config", "item", "fallback_ip6", "count", "w:profile:picture", "image", "business", "2", "hostname", "call-creator", "display_name", "relaylatency", "platform", "abprops", "success", "msg", "offline_preview", "prop", "key-index", "v", "day_of_week", "pkmsg", "version", "1", "ping", "w:p", "download", "video", "set", "specific_hours", "props", "primary", "unknown", "hash", "commerce_experience", "last", "subscribe", "max_buckets", "call", "profile", "member_since_text", "close_time", "call-id", "sticker", "mode", "participants", "value", "query", "profile_options", "open_time", "code", "list", "host", "ts", "contacts", "upload", "lid", "preview", "update", "usync", "w:stats", "delivery", "auth_ttl", "context", "fail", "cart_enabled", "appdata", "category", "atn", "direct_connection", "decrypt-fail", "relay_id", "mmg-fallback.whatsapp.net", "target", "available", "name", "last_id", "mmg.whatsapp.net", "categories", "401", "is_new", "index", "tctoken", "ip4", "token_id", "latency", "recipient", "edit", "ip6", "add", "thumbnail-document", "26", "paused", "true", "identity", "stream:error", "key", "sidelist", "background", "audio", "3", "thumbnail-image", "biz-cover-photo", "cat", "gcm", "thumbnail-video", "error", "auth", "deny", "serial", "in", "registration", "thumbnail-link", "remove", "00", "gif", "thumbnail-gif", "tag", "capability", "multicast", "item-not-found", "description", "business_hours", "config_expo_key", "md-app-state", "expiration", "fallback", "ttl", "300", "md-msg-hist", "device_orientation", "out", "w:m", "open_24h", "side_list", "token", "inactive", "01", "document", "te2", "played", "encrypt", "msgr", "hide", "direct_path", "12", "state", "not-authorized", "url", "terminate", "signature", "status-revoke-delay", "02", "te", "linked_accounts", "trusted_contact", "timezone", "ptt", "kyc-id", "privacy_token", "readreceipts", "appointment_only", "address", "expected_ts", "privacy", "7", "android", "interactive", "device-identity", "enabled", "attribute_padding", "1080", "03", "screen_height"); + + public static final List DOUBLE_BYTE = List.of("read-self", "active", "fbns", "protocol", "reaction", "screen_width", "heartbeat", "deviceid", "2:47DEQpj8", "uploadfieldstat", "voip_settings", "retry", "priority", "longitude", "conflict", "false", "ig_professional", "replaced", "preaccept", "cover_photo", "uncompressed", "encopt", "ppic", "04", "passive", "status-revoke-drop", "keygen", "540", "offer", "rate", "opus", "latitude", "w:gp2", "ver", "4", "business_profile", "medium", "sender", "prev_v_id", "email", "website", "invited", "sign_credential", "05", "transport", "skey", "reason", "peer_abtest_bucket", "America/Sao_Paulo", "appid", "refresh", "100", "06", "404", "101", "104", "107", "102", "109", "103", "member_add_mode", "105", "transaction-id", "110", "106", "outgoing", "108", "111", "tokens", "followers", "ig_handle", "self_pid", "tue", "dec", "thu", "joinable", "peer_pid", "mon", "features", "wed", "peer_device_presence", "pn", "delete", "07", "fri", "audio_duration", "admin", "connected", "delta", "rcat", "disable", "collection", "08", "480", "sat", "phash", "all", "invite", "accept", "critical_unblock_low", "group_update", "signed_credential", "blinded_credential", "eph_setting", "net", "09", "background_location", "refresh_id", "Asia/Kolkata", "privacy_mode_ts", "account_sync", "voip_payload_type", "service_areas", "acs_public_key", "v_id", "0a", "fallback_class", "relay", "actual_actors", "metadata", "w:biz", "5", "connected-limit", "notice", "0b", "host_storage", "fb_page", "subject", "privatestats", "invis", "groupadd", "010", "note.m4r", "uuid", "0c", "8000", "sun", "372", "1020", "stage", "1200", "720", "canonical", "fb", "011", "video_duration", "0d", "1140", "superadmin", "012", "Opening.m4r", "keystore_attestation", "dleq_proof", "013", "timestamp", "ab_key", "w:sync:app:state", "0e", "vertical", "600", "p_v_id", "6", "likes", "014", "500", "1260", "creator", "0f", "rte", "destination", "group", "group_info", "syncd_anti_tampering_fatal_exception_enabled", "015", "dl_bw", "Asia/Jakarta", "vp8/h.264", "online", "1320", "fb:multiway", "10", "timeout", "016", "nse_retry", "urn:xmpp:whatsapp:dirty", "017", "a_v_id", "web_shops_chat_header_button_enabled", "nse_call", "inactive-upgrade", "none", "web", "groups", "2250", "mms_hot_content_timespan_in_seconds", "contact_blacklist", "nse_read", "suspended_group_deletion_notification", "binary_version", "018", "https://www.whatsapp.com/otp/copy/", "reg_push", "shops_hide_catalog_attachment_entrypoint", "server_sync", ".", "ephemeral_messages_allowed_values", "019", "mms_vcache_aggregation_enabled", "iphone", "America/Argentina/Buenos_Aires", "01a", "mms_vcard_autodownload_size_kb", "nse_ver", "shops_header_dropdown_menu_item", "dhash", "catalog_status", "communities_mvp_new_iqs_serverprop", "blocklist", "default", "11", "ephemeral_messages_enabled", "01b", "original_dimensions", "8", "mms4_media_retry_notification_encryption_enabled", "mms4_server_error_receipt_encryption_enabled", "original_image_url", "sync", "multiway", "420", "companion_enc_static", "shops_profile_drawer_entrypoint", "01c", "vcard_as_document_size_kb", "status_video_max_duration", "request_image_url", "01d", "regular_high", "s_t", "abt", "share_ext_min_preliminary_image_quality", "01e", "32", "syncd_key_rotation_enabled", "data_namespace", "md_downgrade_read_receipts2", "patch", "polltype", "ephemeral_messages_setting", "userrate", "15", "partial_pjpeg_bw_threshold", "played-self", "catalog_exists", "01f", "mute_v2", "reject", "dirty", "announcement", "020", "13", "9", "status_video_max_bitrate", "fb:thrift_iq", "offline_batch", "022", "full", "ctwa_first_business_reply_logging", "h.264", "smax_id", "group_description_length", "https://www.whatsapp.com/otp/code", "status_image_max_edge", "smb_upsell_business_profile_enabled", "021", "web_upgrade_to_md_modal", "14", "023", "s_o", "smaller_video_thumbs_status_enabled", "media_max_autodownload", "960", "blocking_status", "peer_msg", "joinable_group_call_client_version", "group_call_video_maximization_enabled", "return_snapshot", "high", "America/Mexico_City", "entry_point_block_logging_enabled", "pop", "024", "1050", "16", "1380", "one_tap_calling_in_group_chat_size", "regular_low", "inline_joinable_education_enabled", "hq_image_max_edge", "locked", "America/Bogota", "smb_biztools_deeplink_enabled", "status_image_quality", "1088", "025", "payments_upi_intent_transaction_limit", "voip", "w:g2", "027", "md_pin_chat_enabled", "026", "multi_scan_pjpeg_download_enabled", "shops_product_grid", "transaction_id", "ctwa_context_enabled", "20", "fna", "hq_image_quality", "alt_jpeg_doc_detection_quality", "group_call_max_participants", "pkey", "America/Belem", "image_max_kbytes", "web_cart_v1_1_order_message_changes_enabled", "ctwa_context_enterprise_enabled", "urn:xmpp:whatsapp:account", "840", "Asia/Kuala_Lumpur", "max_participants", "video_remux_after_repair_enabled", "stella_addressbook_restriction_type", "660", "900", "780", "context_menu_ios13_enabled", "mute-state", "ref", "payments_request_messages", "029", "frskmsg", "vcard_max_size_kb", "sample_buffer_gif_player_enabled", "match_last_seen", "510", "4983", "video_max_bitrate", "028", "w:comms:chat", "17", "frequently_forwarded_max", "groups_privacy_blacklist", "Asia/Karachi", "02a", "web_download_document_thumb_mms_enabled", "02b", "hist_sync", "biz_block_reasons_version", "1024", "18", "web_is_direct_connection_for_plm_transparent", "view_once_write", "file_max_size", "paid_convo_id", "online_privacy_setting", "video_max_edge", "view_once_read", "enhanced_storage_management", "multi_scan_pjpeg_encoding_enabled", "ctwa_context_forward_enabled", "video_transcode_downgrade_enable", "template_doc_mime_types", "hq_image_bw_threshold", "30", "body", "u_aud_limit_sil_restarts_ctrl", "other", "participating", "w:biz:directory", "1110", "vp8", "4018", "meta", "doc_detection_image_max_edge", "image_quality", "1170", "02c", "smb_upsell_chat_banner_enabled", "key_expiry_time_second", "pid", "stella_interop_enabled", "19", "linked_device_max_count", "md_device_sync_enabled", "02d", "02e", "360", "enhanced_block_enabled", "ephemeral_icon_in_forwarding", "paid_convo_status", "gif_provider", "project_name", "server-error", "canonical_url_validation_enabled", "wallpapers_v2", "syncd_clear_chat_delete_chat_enabled", "medianotify", "02f", "shops_required_tos_version", "vote", "reset_skey_on_id_change", "030", "image_max_edge", "multicast_limit_global", "ul_bw", "21", "25", "5000", "poll", "570", "22", "031", "1280", "WhatsApp", "032", "bloks_shops_enabled", "50", "upload_host_switching_enabled", "web_ctwa_context_compose_enabled", "ptt_forwarded_features_enabled", "unblocked", "partial_pjpeg_enabled", "fbid:devices", "height", "ephemeral_group_query_ts", "group_join_permissions", "order", "033", "alt_jpeg_status_quality", "migrate", "popular-bank", "win_uwp_deprecation_killswitch_enabled", "web_download_status_thumb_mms_enabled", "blocking", "url_text", "035", "web_forwarding_limit_to_groups", "1600", "val", "1000", "syncd_msg_date_enabled", "bank-ref-id", "max_subject", "payments_web_enabled", "web_upload_document_thumb_mms_enabled", "size", "request", "ephemeral", "24", "receipt_agg", "ptt_remember_play_position", "sampling_weight", "enc_rekey", "mute_always", "037", "034", "23", "036", "action", "click_to_chat_qr_enabled", "width", "disabled", "038", "md_blocklist_v2", "played_self_enabled", "web_buttons_message_enabled", "flow_id", "clear", "450", "fbid:thread", "bloks_session_state", "America/Lima", "attachment_picker_refresh", "download_host_switching_enabled", "1792", "u_aud_limit_sil_restarts_test2", "custom_urls", "device_fanout", "optimistic_upload", "2000", "key_cipher_suite", "web_smb_upsell_in_biz_profile_enabled", "e", "039", "siri_post_status_shortcut", "pair-device", "lg", "lc", "stream_attribution_url", "model", "mspjpeg_phash_gen", "catalog_send_all", "new_multi_vcards_ui", "share_biz_vcard_enabled", "-", "clean", "200", "md_blocklist_v2_server", "03b", "03a", "web_md_migration_experience", "ptt_conversation_waveform", "u_aud_limit_sil_restarts_test1", "64", "ptt_playback_speed_enabled", "web_product_list_message_enabled", "paid_convo_ts", "27", "manufacturer", "psp-routing", "grp_uii_cleanup", "ptt_draft_enabled", "03c", "business_initiated", "web_catalog_products_onoff", "web_upload_link_thumb_mms_enabled", "03e", "mediaretry", "35", "hfm_string_changes", "28", "America/Fortaleza", "max_keys", "md_mhfs_days", "streaming_upload_chunk_size", "5541", "040", "03d", "2675", "03f", "...", "512", "mute", "48", "041", "alt_jpeg_quality", "60", "042", "md_smb_quick_reply", "5183", "c", "1343", "40", "1230", "043", "044", "mms_cat_v1_forward_hot_override_enabled", "user_notice", "ptt_waveform_send", "047", "Asia/Calcutta", "250", "md_privacy_v2", "31", "29", "128", "md_messaging_enabled", "046", "crypto", "690", "045", "enc_iv", "75", "failure", "ptt_oot_playback", "AIzaSyDR5yfaG7OG8sMTUj8kfQEb8T9pN8BM6Lk", "w", "048", "2201", "web_large_files_ui", "Asia/Makassar", "812", "status_collapse_muted", "1334", "257", "2HP4dm", "049", "patches", "1290", "43cY6T", "America/Caracas", "web_sticker_maker", "campaign", "ptt_pausable_enabled", "33", "42", "attestation", "biz", "04b", "query_linked", "s", "125", "04a", "810", "availability", "1411", "responsiveness_v2_m1", "catalog_not_created", "34", "America/Santiago", "1465", "enc_p", "04d", "status_info", "04f", "key_version", "..", "04c", "04e", "md_group_notification", "1598", "1215", "web_cart_enabled", "37", "630", "1920", "2394", "-1", "vcard", "38", "elapsed", "36", "828", "peer", "pricing_category", "1245", "invalid", "stella_ios_enabled", "2687", "45", "1528", "39", "u_is_redial_audio_1104_ctrl", "1025", "1455", "58", "2524", "2603", "054", "bsp_system_message_enabled", "web_pip_redesign", "051", "verify_apps", "1974", "1272", "1322", "1755", "052", "70", "050", "1063", "1135", "1361", "80", "1096", "1828", "1851", "1251", "1921", "key_config_id", "1254", "1566", "1252", "2525", "critical_block", "1669", "max_available", "w:auth:backup:token", "product", "2530", "870", "1022", "participant_uuid", "web_cart_on_off", "1255", "1432", "1867", "41", "1415", "1440", "240", "1204", "1608", "1690", "1846", "1483", "1687", "1749", "69", "url_number", "053", "1325", "1040", "365", "59", "Asia/Riyadh", "1177", "test_recommended", "057", "1612", "43", "1061", "1518", "1635", "055", "1034", "1375", "750", "1430", "event_code", "1682", "503", "55", "865", "78", "1309", "1365", "44", "America/Guayaquil", "535", "LIMITED", "1377", "1613", "1420", "1599", "1822", "05a", "1681", "password", "1111", "1214", "1376", "1478", "47", "1082", "4282", "Europe/Istanbul", "1307", "46", "058", "1124", "256", "rate-overlimit", "retail", "u_a_socket_err_fix_succ_test", "1292", "1370", "1388", "520", "861", "psa", "regular", "1181", "1766", "05b", "1183", "1213", "1304", "1537", "1724", "profile_picture", "1071", "1314", "1605", "407", "990", "1710", "746", "pricing_model", "056", "059", "061", "1119", "6027", "65", "877", "1607", "05d", "917", "seen", "1516", "49", "470", "973", "1037", "1350", "1394", "1480", "1796", "keys", "794", "1536", "1594", "2378", "1333", "1524", "1825", "116", "309", "52", "808", "827", "909", "495", "1660", "361", "957", "google", "1357", "1565", "1967", "996", "1775", "586", "736", "1052", "1670", "bank", "177", "1416", "2194", "2222", "1454", "1839", "1275", "53", "997", "1629", "6028", "smba", "1378", "1410", "05c", "1849", "727", "create", "1559", "536", "1106", "1310", "1944", "670", "1297", "1316", "1762", "en", "1148", "1295", "1551", "1853", "1890", "1208", "1784", "7200", "05f", "178", "1283", "1332", "381", "643", "1056", "1238", "2024", "2387", "179", "981", "1547", "1705", "05e", "290", "903", "1069", "1285", "2436", "062", "251", "560", "582", "719", "56", "1700", "2321", "325", "448", "613", "777", "791", "51", "488", "902", "Asia/Almaty", "is_hidden", "1398", "1527", "1893", "1999", "2367", "2642", "237", "busy", "065", "067", "233", "590", "993", "1511", "54", "723", "860", "363", "487", "522", "605", "995", "1321", "1691", "1865", "2447", "2462", "NON_TRANSACTIONAL", "433", "871", "432", "1004", "1207", "2032", "2050", "2379", "2446", "279", "636", "703", "904", "248", "370", "691", "700", "1068", "1655", "2334", "060", "063", "364", "533", "534", "567", "1191", "1210", "1473", "1827", "069", "701", "2531", "514", "prev_dhash", "064", "496", "790", "1046", "1139", "1505", "1521", "1108", "207", "544", "637", "final", "1173", "1293", "1694", "1939", "1951", "1993", "2353", "2515", "504", "601", "857", "modify", "spam_request", "p_121_aa_1101_test4", "866", "1427", "1502", "1638", "1744", "2153", "068", "382", "725", "1704", "1864", "1990", "2003", "Asia/Dubai", "508", "531", "1387", "1474", "1632", "2307", "2386", "819", "2014", "066", "387", "1468", "1706", "2186", "2261", "471", "728", "1147", "1372", "1961"); + + public static final int DICTIONARY_VERSION = 3; + + public static final List NUMBERS = List.of('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-', '.', '�', '�', '�', '�'); + + public static final List HEX = List.of('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'); + + public static final String NUMBERS_REGEX = "[^0-9.-]+?"; + + public static final String HEX_REGEX = "[^0-9A-F]+?"; + + public static final Map PROPERTIES; + + static { + var properties = new HashMap(); + properties.put(1719, new CompanionProperty("order_details_total_order_minimum_value", 1719, 1, 1)); + properties.put(1684, new CompanionProperty("order_details_total_maximum_value", 1684, 5.0E8, 5.0E8)); + properties.put(1683, new CompanionProperty("order_details_total_minimum_value", 1683, 0, 0)); + properties.put(3240, new CompanionProperty("order_messages_ephemeral_exception_enabled", 3240, false, true)); + properties.put(233, new CompanionProperty("in_app_support_v2_enabled", 233, false, false)); + properties.put(379, new CompanionProperty("in_app_support_v2_locale_langs", 379, "", "")); + properties.put(390, new CompanionProperty("in_app_support_v2_numbers", 390, "", "")); + properties.put(1031, new CompanionProperty("in_app_support_v2_number_prefixes", 1031, "15517868", "15517868")); + properties.put(4799, new CompanionProperty("in_app_support_capi_number_prefixes", 4799, "155178684", "155178684")); + properties.put(819, new CompanionProperty("in_app_support_v2_jump_to_group", 819, false, false)); + properties.put(974, new CompanionProperty("in_app_support_v2_jump_to_group_wait_time_in_ms", 974, 5000.0, 5000.0)); + properties.put(2765, new CompanionProperty("quick_mute_enabled", 2765, false, false)); + properties.put(308, new CompanionProperty("groups_dogfooding_ui", 308, false, false)); + properties.put(309, new CompanionProperty("md_icdc_enabled", 309, false, false)); + properties.put(310, new CompanionProperty("md_icdc_hash_length", 310, 10, 10)); + properties.put(361, new CompanionProperty("played_self_enabled", 361, false, false)); + properties.put(407, new CompanionProperty("ephemeral_24h_duration", 407, false, true)); + properties.put(536, new CompanionProperty("disappearing_mode", 536, false, false)); + properties.put(605, new CompanionProperty("payments_expressive_backgrounds_enabled", 605, false, true)); + properties.put(432, new CompanionProperty("ephemeral_allow_group_members", 432, false, true)); + properties.put(470, new CompanionProperty("business_profile_refresh_m1_enabled", 470, false, true)); + properties.put(730, new CompanionProperty("num_days_key_index_list_expiration", 730, 35, 35)); + properties.put(731, new CompanionProperty("num_days_before_device_expiry_check", 731, 7, 7)); + properties.put(1098, new CompanionProperty("media_reupload_limit_mb", 1098, 100, 100)); + properties.put(1961, new CompanionProperty("portrait_thumb_enabled_chat", 1961, false, true)); + properties.put(1962, new CompanionProperty("portrait_thumb_enabled_status", 1962, false, true)); + properties.put(4787, new CompanionProperty("channels_video_limit_mb", 4787, 16, 16)); + properties.put(3185, new CompanionProperty("default_video_limit_mb", 3185, 16, 64)); + properties.put(4155, new CompanionProperty("default_video_limit_mb_newsletter", 4155, 16, 16)); + properties.put(3656, new CompanionProperty("default_gif_limit_mb", 3656, 16, 64)); + properties.put(3657, new CompanionProperty("default_audio_limit_mb", 3657, 16, 64)); + properties.put(3660, new CompanionProperty("default_media_limit_mb", 3660, 16, 64)); + properties.put(3934, new CompanionProperty("hd_video_label_enabled", 3934, false, true)); + properties.put(3935, new CompanionProperty("per_send_hd_video_setting_enabled", 3935, false, true)); + properties.put(4138, new CompanionProperty("per_send_hd_video_setting_for_groups_enabled", 4138, false, true)); + properties.put(3936, new CompanionProperty("hd_video_min_streaming_bandwidth", 3936, 150, 150)); + properties.put(4152, new CompanionProperty("hd_video_show_data_warning_dialog", 4152, false, true)); + properties.put(4153, new CompanionProperty("hd_video_data_warning_max_mb", 4153, 64, 64)); + properties.put(4171, new CompanionProperty("hd_video_definition_min_edge", 4171, 720, 720)); + properties.put(4172, new CompanionProperty("hd_video_definition_max_edge", 4172, 864, 864)); + properties.put(4175, new CompanionProperty("hd_video_definition_min_edge_with_max_edge", 4175, 480, 480)); + properties.put(535, new CompanionProperty("message_level_reporting", 535, false, true)); + properties.put(636, new CompanionProperty("native_shop_preview_enabled", 636, false, true)); + properties.put(736, new CompanionProperty("sync_archive_v2_setting", 736, false, false)); + properties.put(637, new CompanionProperty("ptt_conversation_waveform", 637, false, true)); + properties.put(746, new CompanionProperty("ptt_waveform_send", 746, false, true)); + properties.put(753, new CompanionProperty("adv_v2_m4_m5", 753, false, false)); + properties.put(903, new CompanionProperty("adv_v2_m6", 903, false, false)); + properties.put(777, new CompanionProperty("ptt_draft_enabled", 777, false, true)); + properties.put(871, new CompanionProperty("ptt_pausable_enabled", 871, false, true)); + properties.put(791, new CompanionProperty("tos_3_client_gating_enabled", 791, false, false)); + properties.put(877, new CompanionProperty("tos_client_state_fetch_enabled", 877, false, false)); + properties.put(908, new CompanionProperty("tos_client_state_fetch_iteration", 908, 0, 0)); + properties.put(1105, new CompanionProperty("country_client_gating_enabled", 1105, false, false)); + properties.put(1035, new CompanionProperty("system_msg_numbers_fb_branded", 1035, "16505434800,16503130062,16507885324,16508620604,16504228206,447710173736,16315551023,16505361212,16508129150,16315555102,16315558723,16505212669,16507885280,19032707825,0", "16505434800,16503130062,16507885324,16508620604,16504228206,447710173736,16315551023,16505361212,16508129150,16315555102,16315558723,16505212669,16507885280,19032707825,0")); + properties.put(1036, new CompanionProperty("system_msg_numbers_fb_inc", 1036, "", "")); + properties.put(1190, new CompanionProperty("log_clock_skew", 1190, false, false)); + properties.put(794, new CompanionProperty("trusted_contacts", 794, false, false)); + properties.put(995, new CompanionProperty("trusted_contacts_sender", 995, false, false)); + properties.put(922, new CompanionProperty("trusted_contacts_ti", 922, false, false)); + properties.put(865, new CompanionProperty("tctoken_duration", 865, 604800, 604800)); + properties.put(909, new CompanionProperty("tctoken_num_buckets", 909, 4, 4)); + properties.put(996, new CompanionProperty("tctoken_duration_sender", 996, 604800, 604800)); + properties.put(997, new CompanionProperty("tctoken_num_buckets_sender", 997, 4, 4)); + properties.put(827, new CompanionProperty("reactions_receive", 827, false, true)); + properties.put(828, new CompanionProperty("reactions_send", 828, false, true)); + properties.put(1150, new CompanionProperty("reactions_announcement_only", 1150, false, false)); + properties.put(987, new CompanionProperty("reaction_cleanup_days", 987, 31, 31)); + properties.put(1605, new CompanionProperty("reactions_chat_preview", 1605, false, true)); + properties.put(1361, new CompanionProperty("reactions_animations", 1361, false, true)); + properties.put(1485, new CompanionProperty("reactions_animations_simple", 1485, false, true)); + properties.put(861, new CompanionProperty("md_migration_experience", 861, 2, 2)); + properties.put(869, new CompanionProperty("web_abprop_direct_connection_md", 869, false, true)); + properties.put(907, new CompanionProperty("media_upload_prekeys_fetch_enabled", 907, false, true)); + properties.put(1828, new CompanionProperty("reactions_panel_prekeys_fetch_enabled", 1828, false, true)); + properties.put(1455, new CompanionProperty("status_quick_reply_enabled", 1455, false, true)); + properties.put(1974, new CompanionProperty("status_quick_reply_receiver_changes_enabled", 1974, false, true)); + properties.put(952, new CompanionProperty("ptt_remember_play_position", 952, false, true)); + properties.put(957, new CompanionProperty("banned_shops_ux_enabled", 957, false, true)); + properties.put(973, new CompanionProperty("group_suspend_v0_enabled", 973, false, true)); + properties.put(3181, new CompanionProperty("expiring_groups_enabled", 3181, false, false)); + properties.put(3864, new CompanionProperty("community_breakout_groups_enabled", 3864, false, true)); + properties.put(3795, new CompanionProperty("parent_group_directory_enabled", 3795, false, true)); + properties.put(5109, new CompanionProperty("parent_group_join_request_system_enabled", 5109, false, false)); + properties.put(4654, new CompanionProperty("parent_group_member_can_add_enabled", 4654, false, false)); + properties.put(5385, new CompanionProperty("parent_group_member_can_add_default_everyone_enabled", 5385, false, false)); + properties.put(982, new CompanionProperty("parent_group_view_enabled", 982, false, true)); + properties.put(1173, new CompanionProperty("parent_group_create_enabled", 1173, false, true)); + properties.put(1228, new CompanionProperty("parent_group_query_ts", 1228, 0, 0)); + properties.put(1238, new CompanionProperty("parent_group_link_limit", 1238, 100, 100)); + properties.put(3054, new CompanionProperty("allow_subgroup_admin_to_unlink", 3054, false, true)); + properties.put(3246, new CompanionProperty("community_creation_no_add_groups_screen", 3246, false, true)); + properties.put(2774, new CompanionProperty("community_announcement_group_size_limit", 2774, 5000.0, 5000.0)); + properties.put(5656, new CompanionProperty("parent_group_announcement_comments_banner", 5656, false, true)); + properties.put(3121, new CompanionProperty("community_announcement_improvement_m1", 3121, false, true)); + properties.put(3239, new CompanionProperty("community_announcement_improvement_m2", 3239, false, true)); + properties.put(3380, new CompanionProperty("community_announcement_improvement_m3", 3380, false, true)); + properties.put(4053, new CompanionProperty("community_creation_nux_always", 4053, false, false)); + properties.put(4071, new CompanionProperty("community_creation_nux_count", 4071, 1, 1)); + properties.put(3738, new CompanionProperty("community_subgroup_switcher_entrypoint_enabled", 3738, false, true)); + properties.put(3078, new CompanionProperty("community_subgroup_icon_variant", 3078, 0, 2)); + properties.put(4160, new CompanionProperty("community_subgroup_identity_v2", 4160, false, true)); + properties.put(5046, new CompanionProperty("community_history_setting_receive", 5046, false, false)); + properties.put(5191, new CompanionProperty("community_history_setting_send", 5191, false, false)); + properties.put(5192, new CompanionProperty("community_history_receive", 5192, false, false)); + properties.put(5193, new CompanionProperty("community_history_send", 5193, false, false)); + properties.put(1990, new CompanionProperty("parent_group_link_limit_community_creation", 1990, 10, 20)); + properties.put(1655, new CompanionProperty("parent_group_admins_limit", 1655, 20, 20)); + properties.put(2205, new CompanionProperty("parent_group_view_enabled_for_smb_on_web", 2205, false, true)); + properties.put(2206, new CompanionProperty("parent_group_create_enabled_for_smb_on_web", 2206, false, true)); + properties.put(2356, new CompanionProperty("parent_group_create_privacy", 2356, false, true)); + properties.put(2382, new CompanionProperty("parent_group_min_participants_for_group_entry_point", 2382, 20, 1)); + properties.put(2436, new CompanionProperty("parent_group_tap_to_request_enabled", 2436, false, true)); + properties.put(2446, new CompanionProperty("parent_group_tap_to_add_enabled", 2446, false, true)); + properties.put(2447, new CompanionProperty("parent_group_no_disclaimer", 2447, false, true)); + properties.put(3147, new CompanionProperty("parent_group_subgroup_filter", 3147, false, false)); + properties.put(3023, new CompanionProperty("community_groups_navigation", 3023, false, true)); + properties.put(3748, new CompanionProperty("community_chat_list_tabs", 3748, false, false)); + properties.put(3167, new CompanionProperty("parent_group_no_subgroup_requirement", 3167, false, true)); + properties.put(1864, new CompanionProperty("community_admin_promotion_one_time_prompt", 1864, false, false)); + properties.put(2307, new CompanionProperty("document_preview_caption_changes_enabled", 2307, false, true)); + properties.put(1040, new CompanionProperty("forwarded_ptt_ui_enabled", 1040, false, true)); + properties.put(1054, new CompanionProperty("shops_storefront_url_format", 1054, "https://www.facebook.com/%s/shop/", "https://www.facebook.com/%s/shop/")); + properties.put(1135, new CompanionProperty("message_count_logging_md_enabled", 1135, false, false)); + properties.put(2430, new CompanionProperty("url_send_receive_logging_enabled", 2430, false, true)); + properties.put(2431, new CompanionProperty("inline_video_playback_additional_logging_enabled", 2431, false, true)); + properties.put(1064, new CompanionProperty("dev_prop_string", 1064, "", "")); + properties.put(1065, new CompanionProperty("dev_prop_boolean", 1065, false, false)); + properties.put(1066, new CompanionProperty("dev_prop_int", 1066, 0, 0)); + properties.put(1067, new CompanionProperty("dev_prop_float", 1067, 0, 0)); + properties.put(3077, new CompanionProperty("disable_status_to_non_sub", 3077, false, false)); + properties.put(1107, new CompanionProperty("order_details_from_cart_enabled", 1107, false, true)); + properties.put(1176, new CompanionProperty("order_details_custom_item_enabled", 1176, false, true)); + properties.put(1212, new CompanionProperty("order_details_from_catalog_enabled", 1212, false, true)); + properties.put(1187, new CompanionProperty("md_app_state_critical_data_processing_logging", 1187, false, true)); + properties.put(1221, new CompanionProperty("md_app_state_report_md_sync_mutation_stats", 1221, false, true)); + properties.put(1188, new CompanionProperty("order_management_enabled", 1188, false, false)); + properties.put(1204, new CompanionProperty("growth_lock_v0_enabled", 1204, false, true)); + properties.put(1287, new CompanionProperty("smart_filters_enabled_consumer", 1287, false, true)); + properties.put(3554, new CompanionProperty("inbox_management_filters_m2", 3554, false, false)); + properties.put(4991, new CompanionProperty("enable_spam_report_iq_with_privacy_token", 4991, false, true)); + properties.put(4992, new CompanionProperty("enable_privacy_token_with_timestamp", 4992, false, true)); + properties.put(1517, new CompanionProperty("md_offline_v2_m2_enabled", 1517, 10, 10)); + properties.put(1533, new CompanionProperty("profile_photo_rings_for_status_enabled", 1533, false, true)); + properties.put(1534, new CompanionProperty("dc_edit_postcode_by_default_enabled", 1534, false, false)); + properties.put(2614, new CompanionProperty("media_picker_select_limit", 2614, 30, 30)); + properties.put(2693, new CompanionProperty("media_picker_select_limit_new", 2693, 30, 30)); + properties.put(1608, new CompanionProperty("chatlist_filters_v1", 1608, false, false)); + properties.put(1653, new CompanionProperty("community_suspend_v0_enabled", 1653, false, true)); + properties.put(1777, new CompanionProperty("is_meta_employee_or_internal_tester", 1777, false, false)); + properties.put(1838, new CompanionProperty("disable_auto_download", 1838, false, false)); + properties.put(2154, new CompanionProperty("community_tab_m2", 2154, false, true)); + properties.put(2281, new CompanionProperty("gif_autoplay_enabled", 2281, false, false)); + properties.put(3682, new CompanionProperty("gif_min_play_loops", 3682, 1, 1)); + properties.put(3683, new CompanionProperty("gif_max_play_loops", 3683, 3, 3)); + properties.put(3684, new CompanionProperty("gif_max_play_duration", 3684, 5, 5)); + properties.put(1868, new CompanionProperty("web_send_only_active_receipts", 1868, false, true)); + properties.put(2461, new CompanionProperty("num_days_hosted_device_signed_identity_signature_expiration", 2461, 90, 90)); + properties.put(2521, new CompanionProperty("cag_member_key_rotation_optimization", 2521, false, false)); + properties.put(2540, new CompanionProperty("elevated_push_names_v2_enabled", 2540, false, false)); + properties.put(2763, new CompanionProperty("elevated_push_names_v2_m1_follow_up_enabled", 2763, false, false)); + properties.put(2904, new CompanionProperty("elevated_push_names_v2_m2_enabled", 2904, false, false)); + properties.put(2588, new CompanionProperty("smb_capi_coexistence_enabled", 2588, false, true)); + properties.put(2633, new CompanionProperty("smb_client_side_linkshim_enabled", 2633, true, true)); + properties.put(2508, new CompanionProperty("web_non_blocking_offline_resume_max_message_count", 2508, 1000.0, 1000.0)); + properties.put(1809, new CompanionProperty("web_unified_flow", 1809, 0, 0)); + properties.put(2634, new CompanionProperty("smb_client_side_linkshim_signed_regexp", 2634, "https:\\/\\/n\\.wl\\.co\\/[^/]*\\/[^/]*\\/(.*)$", "https:\\/\\/n\\.wl\\.co\\/[^/]*\\/[^/]*\\/(.*)$")); + properties.put(2639, new CompanionProperty("placeholder_message_key_hash_logging", 2639, false, true)); + properties.put(2795, new CompanionProperty("use_appdata_stanza_on_receiver", 2795, false, false)); + properties.put(2796, new CompanionProperty("use_appdata_stanza_on_sender", 2796, false, false)); + properties.put(2814, new CompanionProperty("web_lazy_pull", 2814, false, false)); + properties.put(3806, new CompanionProperty("msgd_drop_device_notifications", 3806, false, false)); + properties.put(3061, new CompanionProperty("media_large_file_awareness_popup_enabled", 3061, false, true)); + properties.put(3115, new CompanionProperty("media_large_file_awareness_popup_file_size_in_MB", 3115, 2048, 2048)); + properties.put(3069, new CompanionProperty("send_cag_member_revokes_as_GDM", 3069, true, true)); + properties.put(3079, new CompanionProperty("parent_group_remove_orphaned_members", 3079, false, true)); + properties.put(3292, new CompanionProperty("community_rich_system_message_enabled", 3292, false, false)); + properties.put(3097, new CompanionProperty("group_mentions_in_cag", 3097, false, true)); + properties.put(4087, new CompanionProperty("group_mentions_in_subgroups", 4087, false, true)); + properties.put(3267, new CompanionProperty("parent_group_home_header_actions_enabled", 3267, false, false)); + properties.put(3191, new CompanionProperty("non_blocking_resume_from_open_tab_enabled", 3191, false, false)); + properties.put(3622, new CompanionProperty("non_blocking_resume_from_open_tab_signal_enabled", 3622, false, false)); + properties.put(3247, new CompanionProperty("smb_catalog_messages_download_thumbnail_on_receiver_enabled", 3247, false, false)); + properties.put(3280, new CompanionProperty("send_extended_nack_enabled", 3280, false, false)); + properties.put(3741, new CompanionProperty("send_message_drop_nack_enabled", 3741, false, false)); + properties.put(4213, new CompanionProperty("send_message_drop_old_couter_nack_enabled", 4213, false, false)); + properties.put(3154, new CompanionProperty("parent_group_enhanced_description_enabled", 3154, false, true)); + properties.put(3616, new CompanionProperty("parent_group_info_updates_enabled", 3616, false, false)); + properties.put(3488, new CompanionProperty("noyb_opt_out_flag", 3488, false, false)); + properties.put(3664, new CompanionProperty("service_improvement_opt_out_flag", 3664, false, false)); + properties.put(3058, new CompanionProperty("wa_ctwa_web_entrypoint_home_header_enabled", 3058, false, false)); + properties.put(3095, new CompanionProperty("wa_ctwa_web_entrypoint_home_header_dropdown_enabled", 3095, false, false)); + properties.put(3096, new CompanionProperty("wa_ctwa_web_entrypoint_home_banner_enabled", 3096, false, false)); + properties.put(3242, new CompanionProperty("wa_ctwa_web_entrypoint_home_icon_tooltip_enabled", 3242, false, false)); + properties.put(3293, new CompanionProperty("wa_ctwa_web_entrypoint_pageless_enabled", 3293, false, false)); + properties.put(3376, new CompanionProperty("wa_ctwa_web_entrypoint_manage_ads_home_header_dropdown_enabled", 3376, false, false)); + properties.put(3294, new CompanionProperty("wa_ctwa_web_fetch_linked_accounts_enabled", 3294, false, false)); + properties.put(3695, new CompanionProperty("report_to_admin_kill_switch", 3695, false, true)); + properties.put(3696, new CompanionProperty("report_to_admin_enabled", 3696, false, true)); + properties.put(3829, new CompanionProperty("parent_group_allow_member_added_groups_m1", 3829, false, true)); + properties.put(4530, new CompanionProperty("parent_group_allow_member_added_groups_default_on_creation", 4530, false, true)); + properties.put(4184, new CompanionProperty("parent_group_allow_member_added_groups_m2", 4184, false, true)); + properties.put(5077, new CompanionProperty("parent_group_allow_member_suggest_existing_m3_sender", 5077, false, true)); + properties.put(5078, new CompanionProperty("parent_group_allow_member_suggest_existing_m3_receiver", 5078, false, true)); + properties.put(5562, new CompanionProperty("events_create", 5562, false, false)); + properties.put(5563, new CompanionProperty("events_view", 5563, false, false)); + properties.put(3224, new CompanionProperty("abort_building_e2e_proto_on_error", 3224, false, true)); + properties.put(4055, new CompanionProperty("abort_decrypting_e2e_on_error", 4055, false, true)); + properties.put(3966, new CompanionProperty("community_shorter_group_creation_enabled", 3966, false, false)); + properties.put(5103, new CompanionProperty("community_stacked_squircle_enabled", 5103, false, false)); + properties.put(5665, new CompanionProperty("community_general_chat_notification_followup_enabled", 5665, false, false)); + properties.put(5169, new CompanionProperty("community_navigate_to_unread_subgroup_enabled", 5169, false, false)); + properties.put(4003, new CompanionProperty("community_navigation", 4003, false, false)); + properties.put(4852, new CompanionProperty("community_examples", 4852, false, true)); + properties.put(5453, new CompanionProperty("community_general_chat_create_enabled", 5453, false, true)); + properties.put(5021, new CompanionProperty("community_general_chat_UI_enabled", 5021, false, true)); + properties.put(5144, new CompanionProperty("community_general_chat_max_auto_add_users", 5144, 1024, 1024)); + properties.put(4010, new CompanionProperty("bonsai_enabled", 4010, false, false)); + properties.put(5362, new CompanionProperty("bonsai_entry_point_enabled", 5362, false, false)); + properties.put(5459, new CompanionProperty("bonsai_waitlist_enabled", 5459, false, false)); + properties.put(4165, new CompanionProperty("bonsai_receiver_enabled", 4165, false, false)); + properties.put(5246, new CompanionProperty("bonsai_inline_feedback_enabled", 5246, false, false)); + properties.put(4416, new CompanionProperty("bonsai_ptt_enabled", 4416, false, false)); + properties.put(4417, new CompanionProperty("bonsai_update_interval", 4417, 86400, 86400)); + properties.put(5413, new CompanionProperty("bonsai_waitlist_update_interval", 5413, 21600, 21600)); + properties.put(4532, new CompanionProperty("bonsai_avatar_enabled", 4532, false, false)); + properties.put(4736, new CompanionProperty("bonsai_ti_timeout_duration_ms", 4736, 10000.0, 10000.0)); + properties.put(4974, new CompanionProperty("bonsai_word_streaming_enabled", 4974, false, false)); + properties.put(5150, new CompanionProperty("bonsai_streaming_chunk_latency", 5150, 0, 0)); + properties.put(5268, new CompanionProperty("bonsai_streaming_line_count_for_pinning", 5268, 4, 4)); + properties.put(5283, new CompanionProperty("bonsai_carousel_enabled", 5283, false, true)); + properties.put(5637, new CompanionProperty("bonsai_english_only", 5637, false, false)); + properties.put(4206, new CompanionProperty("web_mediaretry_notification_nack_enabled", 4206, false, false)); + properties.put(4274, new CompanionProperty("bot_response_futureproof_message_enabled", 4274, false, true)); + properties.put(4836, new CompanionProperty("low_cache_hit_rate_media_types", 4836, "ptt,audio,document,ppic", "ptt,audio,document,ppic")); + properties.put(2898, new CompanionProperty("wa_ctwa_web_thread_ad_attribution_enabled", 2898, false, false)); + properties.put(1495, new CompanionProperty("wa_ctwa_ads_action_banner_enabled", 1495, false, true)); + properties.put(4021, new CompanionProperty("wa_ctwa_ads_action_banner_enabled_web", 4021, false, true)); + properties.put(4022, new CompanionProperty("wa_ctwa_action_banner_logging_enabled_web", 4022, false, true)); + properties.put(1841, new CompanionProperty("ctwa_data_max_length", 1841, 768, 768)); + properties.put(1866, new CompanionProperty("wa_ctwa_action_banner_logging_enabled", 1866, false, true)); + properties.put(2487, new CompanionProperty("wa_ctwa_web_dc_logging_enabled", 2487, false, false)); + properties.put(2934, new CompanionProperty("ctwa_smb_data_sharing_consent", 2934, false, true)); + properties.put(5615, new CompanionProperty("ctwa_smb_data_sharing_settings_killswitch", 5615, false, false)); + properties.put(3331, new CompanionProperty("ctwa_smb_data_sharing_opt_in_cool_off_period", 3331, 259200, 259200)); + properties.put(2935, new CompanionProperty("ctwa_consumer_data_sharing_consent", 2935, false, true)); + properties.put(2936, new CompanionProperty("mark_as_action", 2936, false, true)); + properties.put(3017, new CompanionProperty("pairless_logging_attribution_window", 3017, 7, 7)); + properties.put(3169, new CompanionProperty("wa_biz_tool_logging_improvement", 3169, false, true)); + properties.put(3793, new CompanionProperty("ctwa_additional_label_event_logging_enabled", 3793, false, true)); + properties.put(4761, new CompanionProperty("ctwa_enhanced_label_logging", 4761, false, true)); + properties.put(5151, new CompanionProperty("ctwa_clear_tracking", 5151, false, false)); + properties.put(4542, new CompanionProperty("in_app_comms_manage_ads_web_banner_campaign_enabled", 4542, false, true)); + properties.put(4427, new CompanionProperty("business_tool_enhanced_logging", 4427, false, false)); + properties.put(4796, new CompanionProperty("ctwa_value_holdout_h2_23_enabled", 4796, false, false)); + properties.put(5009, new CompanionProperty("smb_labels_ctwa_data_sharing", 5009, false, true)); + properties.put(5324, new CompanionProperty("smb_message_labels_ctwa_data_sharing", 5324, false, true)); + properties.put(5463, new CompanionProperty("smb_label_improvements_m2", 5463, false, true)); + properties.put(5554, new CompanionProperty("ctwa_manage_ads_tab_web", 5554, false, true)); + properties.put(5671, new CompanionProperty("ctwa_quick_reply_labels", 5671, false, false)); + properties.put(5719, new CompanionProperty("smb_business_action_bar_enabled", 5719, false, false)); + properties.put(1912, new CompanionProperty("ig_reels_music_attribution", 1912, false, true)); + properties.put(2167, new CompanionProperty("video_stream_buffering_ui_enabled", 2167, false, true)); + properties.put(3068, new CompanionProperty("original_quality_image_min_edge", 3068, 2560, 2560)); + properties.put(3306, new CompanionProperty("original_quality_data_warning_max_mb", 3306, 16, 16)); + properties.put(3307, new CompanionProperty("original_quality_show_data_warning_dialog", 3307, false, true)); + properties.put(3613, new CompanionProperty("original_quality_minimum_elements_to_show_data_warning_dialog", 3613, 20, 20)); + properties.put(2915, new CompanionProperty("maximum_group_size_for_rcat", 2915, 100, 100)); + properties.put(2957, new CompanionProperty("web_youtube_rcat_consumption_enabled", 2957, false, true)); + properties.put(3044, new CompanionProperty("web_youtube_rcat_chat_generation_enabled", 3044, false, true)); + properties.put(5178, new CompanionProperty("force_transcode_videos", 5178, false, false)); + properties.put(5179, new CompanionProperty("force_transcode_photos", 5179, false, false)); + properties.put(3273, new CompanionProperty("autodownload_update_in_group_chat", 3273, true, true)); + properties.put(5517, new CompanionProperty("autodownload_update_in_one_one_chat", 5517, false, true)); + properties.put(3116, new CompanionProperty("enable_receiving_hd_photo_quality", 3116, false, true)); + properties.put(3322, new CompanionProperty("enable_days_since_receive_logging", 3322, false, true)); + properties.put(3490, new CompanionProperty("additional_pre_logging_enabled", 3490, false, true)); + properties.put(3820, new CompanionProperty("client_message_id_media_download_log_enabled", 3820, false, true)); + properties.put(3491, new CompanionProperty("media_sender_client_logging_enabled", 3491, false, true)); + properties.put(3349, new CompanionProperty("hqp_log_enabled", 3349, false, true)); + properties.put(3455, new CompanionProperty("web_fix_media_conn_block_rule_parsing", 3455, false, false)); + properties.put(3522, new CompanionProperty("youtube_inline_playback_killswitch", 3522, false, false)); + properties.put(3787, new CompanionProperty("media_engagement_logging_enabled", 3787, false, false)); + properties.put(3844, new CompanionProperty("show_bottom_sheet_gallery", 3844, false, true)); + properties.put(4538, new CompanionProperty("max_pixels_size_allowed_for_image", 4538, 921600, 921600)); + properties.put(4631, new CompanionProperty("fun_stickers_locale_langs", 4631, "en", "en")); + properties.put(4643, new CompanionProperty("fun_stickers_phase2_enabled", 4643, false, false)); + properties.put(5582, new CompanionProperty("enable_media_view_reply", 5582, false, true)); + properties.put(1522, new CompanionProperty("status_inline_link_preview_enabled", 1522, false, true)); + properties.put(1851, new CompanionProperty("text_status_url_logging_enabled", 1851, false, true)); + properties.put(1852, new CompanionProperty("status_reaction_emojis", 1852, "[128525, 128514, 128558, 128546, 128591, 128079, 127881, 128175]", "[128525, 128514, 128558, 128546, 128591, 128079, 127881, 128175]")); + properties.put(1859, new CompanionProperty("status_reply_received_logging_enabled", 1859, false, true)); + properties.put(2032, new CompanionProperty("status_caption_link_detection_enabled", 2032, false, true)); + properties.put(2086, new CompanionProperty("status_view_error_type_logging_enabled", 2086, true, true)); + properties.put(2039, new CompanionProperty("status_from_me_unseen_enabled", 2039, false, true)); + properties.put(451, new CompanionProperty("smb_collections_enabled", 451, false, true)); + properties.put(582, new CompanionProperty("consumer_collections_enabled", 582, false, true)); + properties.put(724, new CompanionProperty("smb_collections_appeal_flow_enabled", 724, false, false)); + properties.put(1074, new CompanionProperty("smb_multi_device_awareness", 1074, false, true)); + properties.put(875, new CompanionProperty("smb_quick_replies_v2_enabled", 875, false, false)); + properties.put(1003, new CompanionProperty("smb_ecommerce_compliance_india_m4", 1003, false, true)); + properties.put(1192, new CompanionProperty("smb_ecommerce_compliance_india_m4_5", 1192, false, true)); + properties.put(1015, new CompanionProperty("smart_filters_enabled", 1015, false, true)); + properties.put(1022, new CompanionProperty("btm_threads_logging_enabled", 1022, false, true)); + properties.put(1034, new CompanionProperty("native_commerce_threads_logging_enabled", 1034, false, true)); + properties.put(1168, new CompanionProperty("threads_logging_observe_list_enabled", 1168, false, true)); + properties.put(1203, new CompanionProperty("smb_hide_unsupported_currency_price", 1203, false, true)); + properties.put(1215, new CompanionProperty("hyperlinked_phone_numbers_enabled", 1215, false, false)); + properties.put(1229, new CompanionProperty("smb_catkit_query_version", 1229, 1, 1)); + properties.put(1263, new CompanionProperty("smb_phase_out_not_a_business", 1263, false, true)); + properties.put(1771, new CompanionProperty("smb_phase_out_not_a_business_V2", 1771, false, true)); + properties.put(1251, new CompanionProperty("smb_threads_logging_enabled", 1251, false, true)); + properties.put(1252, new CompanionProperty("smb_click_to_chat_logging_enabled", 1252, false, true)); + properties.put(1253, new CompanionProperty("smb_broadcast_logging_enabled", 1253, false, true)); + properties.put(1254, new CompanionProperty("smb_status_logging_enabled", 1254, false, true)); + properties.put(1255, new CompanionProperty("smb_biz_profile_logging_enabled", 1255, false, true)); + properties.put(1256, new CompanionProperty("smb_registration_flow_logging_enabled", 1256, false, true)); + properties.put(1272, new CompanionProperty("btm_qpl_enabled", 1272, false, true)); + properties.put(1913, new CompanionProperty("smb_temp_cover_photo_privacy_messaging", 1913, false, true)); + properties.put(1949, new CompanionProperty("show_shops_sunset_banner", 1949, false, true)); + properties.put(3961, new CompanionProperty("vname_logging_and_debugging", 3961, true, true)); + properties.put(3969, new CompanionProperty("verified_business_numbers", 3969, "{}", """ + {"paytm":[917531875318, 919004990049]}""")); + properties.put(4006, new CompanionProperty("verified_business_numbers_for_business_name_update", 4006, "", "917531875318,919004990049")); + properties.put(5001, new CompanionProperty("vname_cert_deprecation", 5001, false, true)); + properties.put(5383, new CompanionProperty("enable_coex_system_message", 5383, false, true)); + properties.put(212, new CompanionProperty("qpl_enabled", 212, false, true)); + properties.put(215, new CompanionProperty("qpl_upload_delay", 215, 1440, 1)); + properties.put(466, new CompanionProperty("qpl_sampling_as_string", 466, """ + json:{"sampling":[]}""", """ + json:{"sampling":[]}""")); + properties.put(1223, new CompanionProperty("qpl_initial_upload_delay", 1223, 5, 1)); + properties.put(1570, new CompanionProperty("is_meta_employee", 1570, false, false)); + properties.put(383, new CompanionProperty("should_deregister_on_syncd_fatal", 383, true, true)); + properties.put(559, new CompanionProperty("group_catch_up", 559, false, false)); + properties.put(591, new CompanionProperty("web_abprop_ctwa_context_compose_enabled", 591, false, false)); + properties.put(592, new CompanionProperty("web_abprop_group_description_length", 592, 0, 0)); + properties.put(593, new CompanionProperty("web_abprop_ephemeral_messages_allowed_values", 593, "604800", "604800")); + properties.put(584, new CompanionProperty("web_abprop_collections_display", 584, false, false)); + properties.put(2312, new CompanionProperty("multi_select_from_chat_list", 2312, false, true)); + properties.put(585, new CompanionProperty("web_abprop_collections_management", 585, false, false)); + properties.put(600, new CompanionProperty("web_abprop_drop_full_history_sync", 600, false, false)); + properties.put(710, new CompanionProperty("web_abprop_business_profile_incomplete_nux_banner", 710, false, false)); + properties.put(711, new CompanionProperty("web_abprop_product_catalog_nux_banner", 711, false, false)); + properties.put(712, new CompanionProperty("web_abprop_click_nux_banner_migration", 712, false, false)); + properties.put(717, new CompanionProperty("web_abprop_ecommerce_compliance_india", 717, false, false)); + properties.put(826, new CompanionProperty("web_abprop_edit_ecommerce_compliance_india", 826, false, false)); + properties.put(726, new CompanionProperty("drop_last_name", 726, false, false)); + properties.put(734, new CompanionProperty("web_abprop_catalog_icon_on_top_bar", 734, false, false)); + properties.put(741, new CompanionProperty("web_abprop_collections_nux_banner", 741, false, false)); + properties.put(760, new CompanionProperty("nfm_rendering_enabled", 760, false, false)); + properties.put(761, new CompanionProperty("web_abprop_nux_cart_interstitial", 761, false, false)); + properties.put(763, new CompanionProperty("web_abprop_business_profile_refresh_status_enabled", 763, false, false)); + properties.put(764, new CompanionProperty("web_abprop_business_profile_refresh_linked_account_enabled", 764, false, false)); + properties.put(765, new CompanionProperty("web_abprop_business_profile_refresh_edit_cover_photo_enabled", 765, false, false)); + properties.put(766, new CompanionProperty("web_abprop_business_profile_refresh_cover_photo_view_enabled", 766, false, false)); + properties.put(809, new CompanionProperty("elevated_important_msg", 809, false, false)); + properties.put(837, new CompanionProperty("web_privacy_settings", 837, false, false)); + properties.put(1226, new CompanionProperty("web_privacy_settings_v2", 1226, false, false)); + properties.put(873, new CompanionProperty("web_status_psa", 873, false, false)); + properties.put(1095, new CompanionProperty("web_status_psa_history_sync", 1095, false, false)); + properties.put(1195, new CompanionProperty("web_2fa", 1195, false, false)); + properties.put(887, new CompanionProperty("web_abprop_stateful_enumeration_enabled", 887, true, true)); + properties.put(894, new CompanionProperty("web_abprop_block_catalog_creation_ecommerce_compliance_india", 894, false, false)); + properties.put(930, new CompanionProperty("web_sticker_store", 930, true, true)); + properties.put(937, new CompanionProperty("web_proactive_prekeys_fetch_group_size_limit", 937, 0, 0)); + properties.put(962, new CompanionProperty("web_favorite_stickers", 962, false, false)); + properties.put(984, new CompanionProperty("web_orchestrator_enabled_version", 984, "bucket", "bucket")); + properties.put(1033, new CompanionProperty("web_wam_v5_enabled", 1033, false, false)); + properties.put(1114, new CompanionProperty("web_ps_v3_enabled", 1114, false, false)); + properties.put(1053, new CompanionProperty("web_shop_storefront_message", 1053, false, false)); + properties.put(1078, new CompanionProperty("web_identity_store_cache", 1078, false, false)); + properties.put(1086, new CompanionProperty("web_abprop_large_files_encryption_optimization", 1086, false, false)); + properties.put(1099, new CompanionProperty("web_send_invisible_msg_to_new_groups", 1099, false, false)); + properties.put(1100, new CompanionProperty("web_send_invisible_msg_min_group_size", 1100, 128, 128)); + properties.put(1945, new CompanionProperty("web_send_invisible_msg_max_group_size", 1945, 1024, 1024)); + properties.put(1171, new CompanionProperty("web_init_chat_batch_size", 1171, 100, 100)); + properties.put(1172, new CompanionProperty("web_init_chat_max_unread_message_count", 1172, 0, 0)); + properties.put(1174, new CompanionProperty("web_abprop_skip_file_copy_on_attach", 1174, false, false)); + properties.put(1179, new CompanionProperty("reaction_history_sync", 1179, false, false)); + properties.put(1189, new CompanionProperty("web_abprop_screen_sharing_enabled", 1189, false, false)); + properties.put(1205, new CompanionProperty("web_graphql_for_catalog_m1", 1205, false, false)); + properties.put(1224, new CompanionProperty("web_adaptive_offline_resume_enabled", 1224, false, false)); + properties.put(1225, new CompanionProperty("web_wa_signal_enabled", 1225, false, false)); + properties.put(1232, new CompanionProperty("web_gdpr_request_account_info_enabled", 1232, false, false)); + properties.put(1247, new CompanionProperty("web_abprop_document_resume_upload", 1247, false, false)); + properties.put(1759, new CompanionProperty("more_reactions_option_desktop_beta_rollout", 1759, true, true)); + properties.put(1796, new CompanionProperty("reactions_keyboard_hides_three_flags_desktop_beta_rollout", 1796, false, false)); + properties.put(1329, new CompanionProperty("web_rotate_sender_key_if_sent", 1329, false, false)); + properties.put(1383, new CompanionProperty("web_lru_cache_purge_logic_refactor", 1383, false, false)); + properties.put(1367, new CompanionProperty("companion_min_versions", 1367, "json:[]", "json:[]")); + properties.put(1368, new CompanionProperty("comparion_force_upgrade", 1368, false, false)); + properties.put(1351, new CompanionProperty("web_abprop_business_profile_refresh_linked_accounts_killswitch", 1351, false, false)); + properties.put(1355, new CompanionProperty("web_default_pull_mode_enabled", 1355, false, false)); + properties.put(1371, new CompanionProperty("web_abprop_chatd_login_cookie_enabled", 1371, false, false)); + properties.put(1373, new CompanionProperty("web_prekeys_fetch_first_batch_size", 1373, 0, 0)); + properties.put(1379, new CompanionProperty("md_app_state_gate_D34336913", 1379, false, false)); + properties.put(1385, new CompanionProperty("web_address_capture_message_enabled", 1385, false, false)); + properties.put(1400, new CompanionProperty("syncd_periodic_sync_days", 1400, 0, 0)); + properties.put(1401, new CompanionProperty("web_enable_hyperlinked_phone_numbers_ps_logging", 1401, false, false)); + properties.put(1451, new CompanionProperty("web_get_maybe_me_user_optimization_enabled", 1451, false, false)); + properties.put(1461, new CompanionProperty("web_should_fatal_on_missing_patch", 1461, true, true)); + properties.put(1479, new CompanionProperty("web_reactions_send_desktop_beta_rollout", 1479, true, true)); + properties.put(1481, new CompanionProperty("web_abprop_remove_uploaded_files", 1481, false, false)); + properties.put(1496, new CompanionProperty("web_abprop_remove_downloaded_files", 1496, false, false)); + properties.put(2879, new CompanionProperty("web_killswitch_s310872_mitigation", 2879, false, false)); + properties.put(1507, new CompanionProperty("web_new_rich_text_input", 1507, true, true)); + properties.put(1513, new CompanionProperty("web_syncd_max_mutations_to_process_during_resume", 1513, 1000.0, 1000.0)); + properties.put(1593, new CompanionProperty("reactions_skin_tone_aggregation", 1593, false, false)); + properties.put(1623, new CompanionProperty("message_quick_reply", 1623, false, false)); + properties.put(1659, new CompanionProperty("web_quantity_controls_enabled", 1659, false, false)); + properties.put(1633, new CompanionProperty("web_unified_message_processing_enabled", 1633, false, false)); + properties.put(1643, new CompanionProperty("web_push_notifications", 1643, false, true)); + properties.put(3868, new CompanionProperty("web_push_notifications_super_users", 3868, false, false)); + properties.put(1676, new CompanionProperty("web_notification_settings_v2", 1676, false, true)); + properties.put(1675, new CompanionProperty("web_abprop_device_agnostic_voip", 1675, false, false)); + properties.put(1680, new CompanionProperty("web_abprop_screen_lock_enabled", 1680, false, false)); + properties.put(4790, new CompanionProperty("web_abprop_screen_lock_show_learn_more_link", 4790, false, false)); + properties.put(1726, new CompanionProperty("web_command_palette", 1726, true, true)); + properties.put(1745, new CompanionProperty("web_group_profile_editor", 1745, true, true)); + properties.put(4901, new CompanionProperty("web_group_profile_picture_stickers_label_fix", 4901, false, true)); + properties.put(1751, new CompanionProperty("web_quick_reply_authoring", 1751, false, false)); + properties.put(1752, new CompanionProperty("web_accidental_delete_for_me", 1752, true, true)); + properties.put(1753, new CompanionProperty("web_abprop_core_wam_runtime", 1753, false, false)); + properties.put(1757, new CompanionProperty("web_profile_picture_db_cache_disabled", 1757, false, false)); + properties.put(1773, new CompanionProperty("web_offline_resume_qpl_enabled", 1773, false, false)); + properties.put(1802, new CompanionProperty("web_offline_resume_m3_enabled", 1802, false, false)); + properties.put(1808, new CompanionProperty("web_syncd_fatal_fields_from_L1104589PRV2", 1808, false, false)); + properties.put(1816, new CompanionProperty("web_media_editor_blur_tool", 1816, true, true)); + properties.put(1824, new CompanionProperty("web_abprop_mute_notifications_on_app_focus", 1824, false, true)); + properties.put(2533, new CompanionProperty("web_auto_mute_256_groups_confirmation", 2533, false, false)); + properties.put(1850, new CompanionProperty("web_multi_skin_toned_emoji_picker", 1850, false, false)); + properties.put(1894, new CompanionProperty("web_message_send_cache_warming_up", 1894, false, true)); + properties.put(2801, new CompanionProperty("web_message_send_precalculate_icdc", 2801, false, true)); + properties.put(1902, new CompanionProperty("web_ptt_streamer_upload", 1902, false, true)); + properties.put(1910, new CompanionProperty("web_prekey_fetch_cache_warming_up", 1910, false, true)); + properties.put(1911, new CompanionProperty("web_history_sync_ui", 1911, false, false)); + properties.put(1932, new CompanionProperty("web_abprop_emoji_experimental_api", 1932, false, false)); + properties.put(1959, new CompanionProperty("web_new_media_caption_input", 1959, true, true)); + properties.put(1964, new CompanionProperty("web_chatlist_toggle", 1964, false, true)); + properties.put(1985, new CompanionProperty("web_electron_deprecation_windows_sideload_stage1_awareness", 1985, false, false)); + properties.put(1986, new CompanionProperty("web_electron_deprecation_windows_sideload_stage2_compatible_expiry_kickoff", 1986, false, false)); + properties.put(1987, new CompanionProperty("web_electron_deprecation_windows_sideload_stage2_compatible_expiry_delay", 1987, 0, 0)); + properties.put(1988, new CompanionProperty("web_electron_deprecation_windows_sideload_stage2_incompatible_expiry_kickoff", 1988, false, false)); + properties.put(1989, new CompanionProperty("web_electron_deprecation_windows_sideload_stage2_incompatible_expiry_delay", 1989, 0, 0)); + properties.put(5101, new CompanionProperty("web_electron_deprecation_mac_appstore_stage_1_awareness", 5101, false, false)); + properties.put(5018, new CompanionProperty("web_electron_deprecation_mac_sideload_stage_1_awareness", 5018, false, false)); + properties.put(5294, new CompanionProperty("web_electron_deprecation_mac_sideload_stage_1_bbar_dismiss_duration_days", 5294, 7, 7)); + properties.put(5019, new CompanionProperty("web_electron_deprecation_mac_sideload_stage_2_expiry_kickoff", 5019, false, false)); + properties.put(5020, new CompanionProperty("web_electron_deprecation_mac_sideload_stage_2_expiry_delay", 5020, 0, 0)); + properties.put(5364, new CompanionProperty("web_electron_deprecation_mac_appstore_stage_2_expiry_kickoff", 5364, false, false)); + properties.put(5365, new CompanionProperty("web_electron_deprecation_mac_appstore_stage_2_expiry_delay", 5365, 0, 0)); + properties.put(2016, new CompanionProperty("web_message_list_a11y_redesign", 2016, true, true)); + properties.put(2018, new CompanionProperty("web_enable_profile_pic_thumb_db_caching", 2018, false, false)); + properties.put(4327, new CompanionProperty("web_enable_profile_pic_thumb_download_over_mms4", 4327, false, false)); + properties.put(2056, new CompanionProperty("web_enable_biz_catalog_view_ps_logging", 2056, true, true)); + properties.put(2063, new CompanionProperty("web_abprop_media_links_docs_search", 2063, false, false)); + properties.put(2179, new CompanionProperty("web_poll_creation_desktop_beta_rollout", 2179, false, false)); + properties.put(2181, new CompanionProperty("web_poll_receiving_desktop_beta_rollout", 2181, false, false)); + properties.put(2210, new CompanionProperty("web_file_streaming_upload", 2210, false, false)); + properties.put(2220, new CompanionProperty("web_new_group_member_search", 2220, false, false)); + properties.put(2264, new CompanionProperty("web_max_contacts_to_show_common_groups", 2264, 10, 10)); + properties.put(2268, new CompanionProperty("web_max_found_common_groups_displayed", 2268, 15, 15)); + properties.put(2231, new CompanionProperty("web_fp_reparsing_for_non_add_ons", 2231, false, false)); + properties.put(2280, new CompanionProperty("web_message_custom_aria_label", 2280, false, false)); + properties.put(2294, new CompanionProperty("web_message_list_a11y_redesign_beta_only", 2294, true, true)); + properties.put(4768, new CompanionProperty("web_search_by_type_date_infra", 4768, false, false)); + properties.put(4769, new CompanionProperty("web_search_by_type_enabled", 4769, false, false)); + properties.put(4770, new CompanionProperty("web_search_by_date_enabled", 4770, false, false)); + properties.put(2303, new CompanionProperty("web_poll_spam_report", 2303, false, false)); + properties.put(2322, new CompanionProperty("web_electron_active_reload", 2322, true, true)); + properties.put(2348, new CompanionProperty("desktop_upsell_win_butterbar", 2348, false, false)); + properties.put(2349, new CompanionProperty("desktop_upsell_win_ctas", 2349, false, false)); + properties.put(2725, new CompanionProperty("desktop_upsell_win_dropdown_btn", 2725, false, false)); + properties.put(4802, new CompanionProperty("desktop_upsell_win_temporary_ctas", 4802, false, false)); + properties.put(4803, new CompanionProperty("desktop_upsell_mac_temporary_ctas", 4803, false, false)); + properties.put(4804, new CompanionProperty("desktop_upsell_win_permanent_ctas", 4804, false, false)); + properties.put(4805, new CompanionProperty("desktop_upsell_mac_permanent_ctas", 4805, false, false)); + properties.put(5145, new CompanionProperty("desktop_upsell_win_cta_chatlist_dropdown", 5145, false, false)); + properties.put(5146, new CompanionProperty("desktop_upsell_win_cta_chatlist_toastbar", 5146, false, false)); + properties.put(5147, new CompanionProperty("desktop_upsell_win_cta_search_results_toastbar", 5147, false, false)); + properties.put(5148, new CompanionProperty("desktop_upsell_win_cta_call_btn", 5148, false, false)); + properties.put(5149, new CompanionProperty("desktop_upsell_win_cta_intro_panel", 5149, false, false)); + properties.put(2486, new CompanionProperty("documents_with_captions_send_desktop_beta_rollout", 2486, false, false)); + properties.put(2512, new CompanionProperty("profile_photo_rings_for_status_on_web_enabled", 2512, false, true)); + properties.put(2513, new CompanionProperty("voice_status_receipt_on_web_enabled", 2513, false, true)); + properties.put(2534, new CompanionProperty("web_crypto_library_enabled", 2534, false, false)); + properties.put(5320, new CompanionProperty("web_crypto_library_verification_enabled", 5320, false, false)); + properties.put(4583, new CompanionProperty("web_crypto_library_with_queues_enabled", 4583, false, false)); + properties.put(2543, new CompanionProperty("group_chat_profile_pictures_enabled_web_beta_rollout", 2543, true, true)); + properties.put(2545, new CompanionProperty("web_message_plugin_backend_registration_enabled", 2545, false, false)); + properties.put(2549, new CompanionProperty("query_verified_name_when_msg_differs", 2549, true, true)); + properties.put(2555, new CompanionProperty("web_media_auto_download_enabled", 2555, false, true)); + properties.put(2556, new CompanionProperty("web_media_auto_download_desktop_beta_enabled", 2556, false, true)); + properties.put(2566, new CompanionProperty("link_preview_wait_time", 2566, 7, 7)); + properties.put(2622, new CompanionProperty("web_screen_lock_max_retries", 2622, 10, 10)); + properties.put(2664, new CompanionProperty("forward_media_with_caption_desktop_beta_rollout", 2664, true, true)); + properties.put(2708, new CompanionProperty("web_new_status_reply_input", 2708, true, true)); + properties.put(2715, new CompanionProperty("web_display_name_for_enterprise_biz_vlevel_low_killswitch", 2715, false, false)); + properties.put(2716, new CompanionProperty("web_display_name_for_biz_vlevel_low_killswitch", 2716, true, true)); + properties.put(2793, new CompanionProperty("web_message_plugin_frontend_registration_enabled", 2793, false, false)); + properties.put(3081, new CompanionProperty("external_beta_can_join", 3081, false, true)); + properties.put(3031, new CompanionProperty("web_native_fetch_media_download", 3031, false, false)); + properties.put(3042, new CompanionProperty("web_image_max_edge", 3042, 1600, 1600)); + properties.put(3204, new CompanionProperty("web_image_max_hd_edge", 3204, 2560, 2560)); + properties.put(3118, new CompanionProperty("enable_logging_multi_select_from_chat_list", 3118, false, true)); + properties.put(3133, new CompanionProperty("web_store_quota_manager_enabled", 3133, false, false)); + properties.put(4670, new CompanionProperty("web_chat_with_unknown_contacts", 4670, false, false)); + properties.put(3134, new CompanionProperty("web_browser_quota_threshold", 3134, 100, 100)); + properties.put(3135, new CompanionProperty("web_browser_min_storage_quota", 3135, 5, 5)); + properties.put(3136, new CompanionProperty("web_original_photo_quality_upload_enabled", 3136, false, false)); + properties.put(3152, new CompanionProperty("web_deprecate_mms4_hash_based_download", 3152, false, true)); + properties.put(3164, new CompanionProperty("web_md5_message_key", 3164, false, true)); + properties.put(3729, new CompanionProperty("web_sha256_message_key", 3729, true, true)); + properties.put(3234, new CompanionProperty("web_e2e_backfill_expire_time", 3234, 5, 60)); + properties.put(3279, new CompanionProperty("web_message_table_index_rowid_optimization", 3279, false, false)); + properties.put(3350, new CompanionProperty("wds_radius_and_casing", 3350, false, true)); + properties.put(4032, new CompanionProperty("web_attach_menu_redesign", 4032, false, true)); + properties.put(3420, new CompanionProperty("web_expression_panels", 3420, false, false)); + properties.put(3600, new CompanionProperty("can_support_web_column_packing", 3600, false, false)); + properties.put(3970, new CompanionProperty("web_column_data_serialization_enabled", 3970, false, false)); + properties.put(3973, new CompanionProperty("column_serialization_perf_impact_test", 3973, false, false)); + properties.put(3723, new CompanionProperty("web_message_edit_receive_desktop_beta_rollout", 3723, false, false)); + properties.put(3724, new CompanionProperty("web_message_edit_send_desktop_beta_rollout", 3724, false, false)); + properties.put(3883, new CompanionProperty("web_message_edit_processing_reply_messages", 3883, true, true)); + properties.put(3728, new CompanionProperty("web_message_processing_cache_size", 3728, 400, 400)); + properties.put(3779, new CompanionProperty("web_encryption_failed_message_resend", 3779, false, false)); + properties.put(3818, new CompanionProperty("append_message_when_forwarding_media_desktop_beta", 3818, false, false)); + properties.put(3890, new CompanionProperty("web_client_pull_timeout_ms", 3890, 10000.0, 10000.0)); + properties.put(3892, new CompanionProperty("web_socket_reconnect_enabled", 3892, false, false)); + properties.put(4019, new CompanionProperty("web_outgoing_message_validation_list", 4019, "[]", "[]")); + properties.put(4024, new CompanionProperty("web_device_sync_manager_enabled", 4024, false, false)); + properties.put(4453, new CompanionProperty("web_device_sync_manager_group_enabled", 4453, false, false)); + properties.put(4125, new CompanionProperty("web_draft_message_enabled", 4125, false, false)); + properties.put(4149, new CompanionProperty("history_sync_loop_interval_ms", 4149, 20000.0, 20000.0)); + properties.put(4364, new CompanionProperty("history_sync_on_demand_failure_limit", 4364, 10, 10)); + properties.put(4365, new CompanionProperty("history_sync_on_demand_cooldown_sec", 4365, 7200, 7200)); + properties.put(4366, new CompanionProperty("history_sync_on_demand_request_send_killswitch", 4366, true, true)); + properties.put(4390, new CompanionProperty("flattened_reactions_collection", 4390, false, false)); + properties.put(4403, new CompanionProperty("web_offline_notification_priority", 4403, false, false)); + properties.put(4404, new CompanionProperty("web_status_posting_enabled", 4404, false, false)); + properties.put(4475, new CompanionProperty("unified_pin_addon_infra_enabled", 4475, false, false)); + properties.put(4483, new CompanionProperty("web_enable_open_tab_pre_ack", 4483, false, false)); + properties.put(4669, new CompanionProperty("web_improved_text_tool_enabled", 4669, false, false)); + properties.put(4681, new CompanionProperty("web_internal_in_app_bug_reporting_enable", 4681, false, false)); + properties.put(4726, new CompanionProperty("web_sticker_suggestions_enable", 4726, false, false)); + properties.put(4724, new CompanionProperty("web_enable_capi_support_chat", 4724, false, false)); + properties.put(4792, new CompanionProperty("web_device_switching", 4792, false, true)); + properties.put(4904, new CompanionProperty("web_initial_sync_encrypted_msgs_storing", 4904, false, false)); + properties.put(4951, new CompanionProperty("web_expression_panels_mitigations", 4951, false, true)); + properties.put(4952, new CompanionProperty("web_animate_messages", 4952, false, false)); + properties.put(5523, new CompanionProperty("web_animate_new_messages", 5523, false, true)); + properties.put(4973, new CompanionProperty("web_improved_message_composer_enabled", 4973, false, false)); + properties.put(5079, new CompanionProperty("web_preload_chat_messages", 5079, false, true)); + properties.put(5080, new CompanionProperty("web_anyone_can_add_group_setting_enabled", 5080, false, true)); + properties.put(5100, new CompanionProperty("web_command_palette_plugins", 5100, false, false)); + properties.put(5106, new CompanionProperty("web_noncritical_history_sync_message_processing_break_iteration", 5106, 100, 100)); + properties.put(5110, new CompanionProperty("web_tc_token_db_read_enabled", 5110, false, false)); + properties.put(5164, new CompanionProperty("web_invalid_message_count_validation", 5164, false, true)); + properties.put(5165, new CompanionProperty("web_invalid_media_message_validation", 5165, false, true)); + properties.put(5271, new CompanionProperty("web_offline_dynamic_batch_size_enabled", 5271, false, true)); + properties.put(5297, new CompanionProperty("web_offline_dynamic_batch_config", 5297, """ + {"denominator": 2}""", """ + {"denominator": 2}""")); + properties.put(5291, new CompanionProperty("web_history_sync_notification_handling_queue_v2", 5291, false, false)); + properties.put(5346, new CompanionProperty("web_evolve_about_receive_enabled", 5346, false, false)); + properties.put(5347, new CompanionProperty("web_evolve_about_send_enabled", 5347, false, false)); + properties.put(5388, new CompanionProperty("web_abort_building_e2e_proto_on_error", 5388, false, true)); + properties.put(5389, new CompanionProperty("web_abort_decrypting_e2e_on_error", 5389, false, true)); + properties.put(5410, new CompanionProperty("web_offline_progress_toastbar", 5410, false, true)); + properties.put(5447, new CompanionProperty("web_quoted_generate_msg_data", 5447, false, false)); + properties.put(5461, new CompanionProperty("web_resume_optimized_read_receipt_send_active_chat", 5461, false, true)); + properties.put(5502, new CompanionProperty("web_resume_optimized_read_receipt_send_interval", 5502, 500, 500)); + properties.put(5520, new CompanionProperty("web_pre_acks_m2_enabled", 5520, false, false)); + properties.put(5521, new CompanionProperty("web_pre_acks_m3_enabled", 5521, false, false)); + properties.put(5564, new CompanionProperty("web_push_notifications_receipt_handling_enabled", 5564, false, false)); + properties.put(5565, new CompanionProperty("desktop_upsell_mac_cta_chatlist_dropdown", 5565, false, false)); + properties.put(5566, new CompanionProperty("desktop_upsell_mac_cta_chatlist_toastbar", 5566, false, false)); + properties.put(5567, new CompanionProperty("desktop_upsell_mac_cta_search_results_toastbar", 5567, false, false)); + properties.put(5568, new CompanionProperty("desktop_upsell_mac_cta_call_btn", 5568, false, false)); + properties.put(5569, new CompanionProperty("desktop_upsell_mac_cta_intro_panel", 5569, false, false)); + properties.put(5677, new CompanionProperty("web_add_non_contacts_to_groups_enabled", 5677, false, false)); + properties.put(5680, new CompanionProperty("web_resume_optimized_message_post_processing_enabled", 5680, false, true)); + properties.put(5708, new CompanionProperty("web_biz_tools_on_navbar_enabled", 5708, false, false)); + properties.put(315, new CompanionProperty("stop_abprops_traffic_in_serverprops_response", 315, false, false)); + properties.put(3689, new CompanionProperty("chat_upsell_for_1on1_invites", 3689, false, false)); + properties.put(4118, new CompanionProperty("ugc_participant_limit", 4118, 5, 5)); + properties.put(4441, new CompanionProperty("anyone_can_add_to_groups_by_default", 4441, false, false)); + properties.put(4593, new CompanionProperty("group_join_request_on_by_default", 4593, false, false)); + properties.put(1825, new CompanionProperty("group_chat_profile_pictures_enabled", 1825, false, false)); + properties.put(3261, new CompanionProperty("group_chat_profile_pictures_v2_enabled", 3261, false, false)); + properties.put(3523, new CompanionProperty("unified_user_profile_navigation_enabled", 3523, false, false)); + properties.put(4215, new CompanionProperty("view_all_replies_enabled", 4215, false, false)); + properties.put(4545, new CompanionProperty("top_menu_redesign_enabled", 4545, false, false)); + properties.put(3010, new CompanionProperty("ugr_enabled", 3010, false, true)); + properties.put(3011, new CompanionProperty("ugc_enabled", 3011, false, true)); + properties.put(5002, new CompanionProperty("ug_chat_banner_enabled", 5002, false, true)); + properties.put(5016, new CompanionProperty("ug_chat_banner_visibility_max_seconds", 5016, 432000.0, 432000.0)); + properties.put(5119, new CompanionProperty("ug_chat_banner_visibility_min_seconds", 5119, 0, 0)); + properties.put(3088, new CompanionProperty("reword_subject_to_group_name_enabled", 3088, false, true)); + properties.put(1693, new CompanionProperty("commerce_metadata_supported_business", 1693, "18785550326,918591749310,917977079770,12245555037,5515997781156,5511989238421,555191894444,905333860133,908502213040,5511916282555,555139214004,555198849745,551147664020,622150851766,551121038525", "18785550326,447766028329,918591749310,917977079770,12245555037,5515997781156,5511989238421,555191894444,905333860133,908502213040,5511916282555,555139214004,555198849745,551147664020,622150851766")); + properties.put(1607, new CompanionProperty("in_app_survey_phone_numbers", 1607, "16508638904", "16508638904")); + properties.put(1595, new CompanionProperty("order_details_payment_instructions_enabled", 1595, false, true)); + properties.put(455, new CompanionProperty("enable_biz_activity_report_request", 455, false, false)); + properties.put(464, new CompanionProperty("plm_products_max_batch_fetch_size", 464, 18, 18)); + properties.put(550, new CompanionProperty("enable_granular_reject_reasons", 550, false, false)); + properties.put(604, new CompanionProperty("elevating_profile_names_enabled", 604, false, false)); + properties.put(689, new CompanionProperty("enable_group_profile_editor", 689, false, false)); + properties.put(690, new CompanionProperty("csat_message_rating", 690, false, true)); + properties.put(810, new CompanionProperty("facebook_link_preview_use_thumbnail", 810, false, true)); + properties.put(838, new CompanionProperty("tam_attachment_cache_compaction_enabled", 838, false, false)); + properties.put(853, new CompanionProperty("business_threads_logging_enabled", 853, false, false)); + properties.put(904, new CompanionProperty("private_stats_biz_view_logging_enabled", 904, false, false)); + properties.put(2367, new CompanionProperty("group_join_request_m0_anyone_can_join", 2367, false, false)); + properties.put(1727, new CompanionProperty("group_join_request_m1", 1727, false, false)); + properties.put(1728, new CompanionProperty("group_join_request_m2", 1728, false, false)); + properties.put(4727, new CompanionProperty("parent_group_announcement_comments_enabled", 4727, false, false)); + properties.put(5141, new CompanionProperty("parent_group_announcement_comments_receiver_enabled", 5141, false, false)); + properties.put(5660, new CompanionProperty("parent_group_announcement_comments_sender_use_lid", 5660, true, true)); + properties.put(4728, new CompanionProperty("parent_group_announcement_comments_participant_limit", 4728, 1024, 1024)); + properties.put(4729, new CompanionProperty("parent_group_announcement_comment_subscription_enabled", 4729, false, false)); + properties.put(1887, new CompanionProperty("group_join_request_m2_setting", 1887, false, false)); + properties.put(2913, new CompanionProperty("group_join_request_m2_logging", 2913, false, false)); + properties.put(2418, new CompanionProperty("group_join_request_m2_max_pending_participants_limit", 2418, 2, 2)); + properties.put(2369, new CompanionProperty("group_join_request_m3", 2369, false, false)); + properties.put(3451, new CompanionProperty("group_join_request_m3_sort_by_time", 3451, false, false)); + properties.put(3571, new CompanionProperty("group_join_request_m3_invited_tab", 3571, false, false)); + properties.put(3895, new CompanionProperty("group_join_request_m3_groups_in_common", 3895, false, false)); + properties.put(3452, new CompanionProperty("group_join_request_m3_banner", 3452, false, false)); + properties.put(5212, new CompanionProperty("group_join_request_m3_push_notification", 5212, false, false)); + properties.put(3382, new CompanionProperty("group_join_request_optional_message_soak", 3382, false, false)); + properties.put(3383, new CompanionProperty("group_join_request_can_view_optional_message", 3383, false, false)); + properties.put(3384, new CompanionProperty("group_join_request_can_send_optional_message", 3384, false, false)); + properties.put(2376, new CompanionProperty("group_join_request_m2_pushname", 2376, false, true)); + properties.put(2449, new CompanionProperty("group_join_request_m2_banner_on_conversation", 2449, false, false)); + properties.put(2749, new CompanionProperty("group_invite_new_bottom_sheet_enabled", 2749, true, true)); + properties.put(1967, new CompanionProperty("note_to_self", 1967, false, true)); + properties.put(2630, new CompanionProperty("note_to_self_entry_point", 2630, false, true)); + properties.put(1011, new CompanionProperty("no_delete_message_time_limit", 1011, false, false)); + properties.put(1333, new CompanionProperty("sender_revoke_window_sender", 1333, false, true)); + properties.put(1334, new CompanionProperty("sender_revoke_window_receiver", 1334, false, true)); + properties.put(1335, new CompanionProperty("sender_revoke_ui", 1335, false, true)); + properties.put(1177, new CompanionProperty("admin_revoke_receiver", 1177, false, true)); + properties.put(1292, new CompanionProperty("admin_revoke_sender", 1292, false, true)); + properties.put(1245, new CompanionProperty("admin_revoke_history_sync_consumer", 1245, false, true)); + properties.put(1865, new CompanionProperty("revokes_logging_unsampled", 1865, true, true)); + properties.put(3138, new CompanionProperty("pinned_messages_m0", 3138, false, false)); + properties.put(3139, new CompanionProperty("pinned_messages_m1_receiver", 3139, false, false)); + properties.put(5474, new CompanionProperty("pinned_messsages_m1_receiver_first_time_server_ts_storage", 5474, false, false)); + properties.put(3140, new CompanionProperty("pinned_messages_m1_sender", 3140, false, false)); + properties.put(3813, new CompanionProperty("pinned_messages_m1_sender_debug_expiry_duration_secs", 3813, 86400, 86400)); + properties.put(4432, new CompanionProperty("pinned_messages_sender_short_expiry_durations_enabled", 4432, false, false)); + properties.put(3732, new CompanionProperty("pinned_messages_m2_pin_max", 3732, 1, 1)); + properties.put(3141, new CompanionProperty("pinned_messages_m2", 3141, false, false)); + properties.put(1021, new CompanionProperty("admin_hfm_toggle", 1021, false, false)); + properties.put(1082, new CompanionProperty("csat_message_trigger", 1082, false, true)); + properties.put(1096, new CompanionProperty("graphql_privacy_imp_m1", 1096, false, false)); + properties.put(1104, new CompanionProperty("lthash_check_hours", 1104, 0, 0)); + properties.put(1133, new CompanionProperty("interactive_message_native_flow_killswitch", 1133, false, false)); + properties.put(1185, new CompanionProperty("sender_key_expired_logging_enabled", 1185, false, false)); + properties.put(1861, new CompanionProperty("group_size_bypassing_sampling", 1861, 100000.0, 100000.0)); + properties.put(1304, new CompanionProperty("group_size_limit", 1304, 257, 257)); + properties.put(2334, new CompanionProperty("v_id_deprecation_enabled", 2334, false, true)); + properties.put(2757, new CompanionProperty("proactive_distribute_sender_keys_enabled", 2757, false, true)); + properties.put(2860, new CompanionProperty("minimum_percentage_to_proactive_distribute_sender_keys", 2860, 200, 50)); + properties.put(1538, new CompanionProperty("address_message_native_flow_killswitch", 1538, false, false)); + properties.put(1319, new CompanionProperty("commerce_sanctioned", 1319, false, false)); + properties.put(1320, new CompanionProperty("commerce_bloks_apps_mapping", 1320, """ + {"address_message":{"app_id":"com.bloks.www.whatsapp.commerce.address_message","expiration_secs":300,"version":"1.5","supported_businesses":["+918591749310","+917977079770","+12165552716","+918591749310","+917977079770","+919324433533","+917669800185","+919355081749","+917217010106","+912248913727","+912068135414","+918368818019","+917827971992","+917827971988","+911244632002","+919999006542","+917982465931","+911244632030","+918920528558","+911244632026","+918920530301","+15550083895","+12995550004","+6589523673","+6597685939","+6580536071","+6531631404","+6590834813","+6588867112","+16615555837","+12765985268","+18055908026"]},"galaxy_message":{"flow_message_version":{"1":{"min_android_app_supported_version":"2.22.21","min_ios_app_supported_version":"2.22.16"}},"app_id":"com.bloks.www.whatsapp.commerce.galaxy_message","expiration_secs":86400,"version":"1.0","flows":{"5315848498536354":{"supported_businesses":["18785550326","19505550093","18055555085","12115551400","12165554570"]},"384213690506206":{"supported_businesses":["13072224829","908502213040"]},"785254429343710":{"supported_businesses":["13072224829","908502213040"]},"552092896712166":{"supported_businesses":["13072224829","908502213040"]},"659207712435246":{"supported_businesses":["13072224829","908502213040"]},"1218944301990105":{"supported_businesses":["13072224829","908502213040"]},"842529276647219":{"supported_businesses":["908502419528","905333860133"]},"2135286959994016":{"supported_businesses":["908502419528","905333860133"]},"465280328842503":{"supported_businesses":["908502419528","905333860133"]},"554437403152809":{"supported_businesses":["908502419528","905333860133"]},"1503880053408592":{"supported_businesses":["908502419528","905333860133"]},"1177261906521760":{"supported_businesses":["908502419528","905333860133"]},"5199590820090002":{"supported_businesses":["5511989238421"]},"615215783523200":{"supported_businesses":["5511989238421"]},"1160930701174631":{"supported_businesses":["5511989238421","555191894444"]},"2934205950056123":{"supported_businesses":["5511916282555"]},"5324889264212944":{"supported_businesses":["5511916282555"]},"3301029236883120":{"supported_businesses":["555139214004","555198849745"]},"774830743793476":{"supported_businesses":["555139214004","555198849745"]},"1493489641166601":{"supported_businesses":["555139214004","555198849745"]},"1115920052387436":{"supported_businesses":["555139214004","555198849745"]},"611775360605929":{"supported_businesses":["551147664020","551121038525"]},"1283565282457467":{"supported_businesses":["551147664020","551121038525"]},"673695173931335":{"supported_businesses":["551147664020","551121038525"]},"508459817855605":{"supported_businesses":["442034673249","447418310027"]},"639247544356777":{"supported_businesses":["442034673249","447418310027","622150851766"]},"2679509568858534":{"supported_businesses":["442034673249","447418310027","622150851766"]}}}}""", """ + {"address_message":{"app_id":"com.bloks.www.whatsapp.commerce.address_message","expiration_secs":300,"version":"1.5","supported_businesses":["+918591749310","+917977079770","+12165552716","+918591749310","+917977079770","+919324433533","+917669800185","+919355081749","+917217010106","+912248913727","+912068135414","+918368818019","+917827971992","+917827971988","+911244632002","+919999006542","+917982465931","+911244632030","+918920528558","+911244632026","+918920530301","+15550083895","+12995550004","+6589523673","+6597685939","+6580536071","+6531631404","+6590834813","+6588867112","+16615555837","+12765985268","+18055908026"]},"galaxy_message":{"flow_message_version":{"1":{"min_android_app_supported_version":"2.22.21","min_ios_app_supported_version":"2.22.16"}},"app_id":"com.bloks.www.whatsapp.commerce.galaxy_message","expiration_secs":86400,"version":"1.0","flows":{"5315848498536354":{"supported_businesses":["18785550326","19505550093","18055555085","12115551400","12165554570"]},"384213690506206":{"supported_businesses":["13072224829","908502213040"]},"785254429343710":{"supported_businesses":["13072224829","908502213040"]},"552092896712166":{"supported_businesses":["13072224829","908502213040"]},"659207712435246":{"supported_businesses":["13072224829","908502213040"]},"1218944301990105":{"supported_businesses":["13072224829","908502213040"]},"842529276647219":{"supported_businesses":["908502419528","905333860133"]},"2135286959994016":{"supported_businesses":["908502419528","905333860133"]},"465280328842503":{"supported_businesses":["908502419528","905333860133"]},"554437403152809":{"supported_businesses":["908502419528","905333860133"]},"1503880053408592":{"supported_businesses":["908502419528","905333860133"]},"1177261906521760":{"supported_businesses":["908502419528","905333860133"]},"5199590820090002":{"supported_businesses":["5511989238421"]},"615215783523200":{"supported_businesses":["5511989238421"]},"1160930701174631":{"supported_businesses":["5511989238421","555191894444"]},"2934205950056123":{"supported_businesses":["5511916282555"]},"5324889264212944":{"supported_businesses":["5511916282555"]},"3301029236883120":{"supported_businesses":["555139214004","555198849745"]},"774830743793476":{"supported_businesses":["555139214004","555198849745"]},"1493489641166601":{"supported_businesses":["555139214004","555198849745"]},"1115920052387436":{"supported_businesses":["555139214004","555198849745"]},"611775360605929":{"supported_businesses":["551147664020","551121038525"]},"1283565282457467":{"supported_businesses":["551147664020","551121038525"]},"673695173931335":{"supported_businesses":["551147664020","551121038525"]},"508459817855605":{"supported_businesses":["442034673249","447418310027"]},"639247544356777":{"supported_businesses":["442034673249","447418310027","622150851766"]},"2679509568858534":{"supported_businesses":["442034673249","447418310027","622150851766"]}}}}""")); + properties.put(1327, new CompanionProperty("graphql_privacy_imp_m2", 1327, false, false)); + properties.put(1343, new CompanionProperty("nux_sync", 1343, false, true)); + properties.put(1377, new CompanionProperty("in_app_survey_enabled", 1377, false, true)); + properties.put(1394, new CompanionProperty("poll_creation_enabled", 1394, false, false)); + properties.put(1395, new CompanionProperty("poll_receiving_enabled", 1395, false, false)); + properties.put(2737, new CompanionProperty("poll_receiving_cag_enabled", 2737, false, false)); + properties.put(1406, new CompanionProperty("poll_name_length", 1406, 255, 255)); + properties.put(1407, new CompanionProperty("poll_option_length", 1407, 100, 100)); + properties.put(1408, new CompanionProperty("poll_option_count", 1408, 12, 12)); + properties.put(1409, new CompanionProperty("poll_offline_accuracy", 1409, 30, 30)); + properties.put(1410, new CompanionProperty("poll_cleanup_days", 1410, 31, 31)); + properties.put(1541, new CompanionProperty("poll_vote_processing_enabled", 1541, false, false)); + properties.put(1948, new CompanionProperty("poll_result_details_view_enabled", 1948, true, true)); + properties.put(2194, new CompanionProperty("poll_creation_one_on_one_chats_enabled", 2194, false, false)); + properties.put(2738, new CompanionProperty("poll_creation_cag_enabled", 2738, false, false)); + properties.put(2390, new CompanionProperty("poll_a11y_enabled", 2390, false, true)); + properties.put(2728, new CompanionProperty("enable_status_reporting", 2728, false, true)); + properties.put(1415, new CompanionProperty("group_suspend_v1_enabled", 1415, false, true)); + properties.put(2057, new CompanionProperty("group_suspend_appeal_include_entity_id_enabled", 2057, false, true)); + properties.put(2290, new CompanionProperty("block_from_chat_list", 2290, false, true)); + properties.put(2818, new CompanionProperty("community_reporting_ui_upsell_exit", 2818, true, true)); + properties.put(1417, new CompanionProperty("smb_product_price_label", 1417, "control", "control")); + properties.put(1435, new CompanionProperty("interactive_response_message_killswitch", 1435, false, false)); + properties.put(1436, new CompanionProperty("interactive_response_message_native_flow_killswitch", 1436, false, false)); + properties.put(1464, new CompanionProperty("biz_api_voip_enabled", 1464, false, false)); + properties.put(1480, new CompanionProperty("quantity_controls_enabled", 1480, false, true)); + properties.put(1514, new CompanionProperty("catalog_categories_enabled", 1514, false, true)); + properties.put(1518, new CompanionProperty("disappearing_messages_chat_picker", 1518, false, false)); + properties.put(1322, new CompanionProperty("more_reactions_option", 1322, false, false)); + properties.put(1792, new CompanionProperty("reactions_keyboard_hides_three_flags", 1792, false, false)); + properties.put(2170, new CompanionProperty("send_reaction_from_details_pane", 2170, false, false)); + properties.put(1527, new CompanionProperty("silent_group_exit", 1527, false, true)); + properties.put(1528, new CompanionProperty("silent_group_exit_past_participants", 1528, false, true)); + properties.put(1597, new CompanionProperty("silent_group_exit_dialog", 1597, false, true)); + properties.put(1598, new CompanionProperty("silent_group_exit_sync", 1598, false, true)); + properties.put(1613, new CompanionProperty("silent_group_exit_db", 1613, false, true)); + properties.put(1600, new CompanionProperty("order_details_quick_pay", 1600, """ + {"allowed_product_type":"none"}""", """ + {"allowed_product_type":"none"}""")); + properties.put(1599, new CompanionProperty("incentive_program_logging_enabled", 1599, false, true)); + properties.put(1612, new CompanionProperty("md_syncd_24_hour_time_format_sync_enabled", 1612, false, false)); + properties.put(2734, new CompanionProperty("md_link_device_with_phone_number_enabled", 2734, false, false)); + properties.put(3693, new CompanionProperty("md_link_device_with_phone_number_force_enabled", 3693, false, false)); + properties.put(1660, new CompanionProperty("send_cart_cta_long_button_enabled", 1660, true, true)); + properties.put(2153, new CompanionProperty("send_cart_cta_long_button_alternative_text_type", 2153, 0, 0)); + properties.put(1678, new CompanionProperty("product_search_m1_enabled", 1678, false, true)); + properties.put(1688, new CompanionProperty("smb_catalog_collections_reordering_enabled", 1688, true, true)); + properties.put(1794, new CompanionProperty("smb_catalog_collection_items_reordering_enabled", 1794, true, true)); + properties.put(1707, new CompanionProperty("is_message_secret_enabled", 1707, false, true)); + properties.put(1749, new CompanionProperty("documents_with_captions_receive", 1749, false, true)); + properties.put(1750, new CompanionProperty("documents_with_captions_send", 1750, false, true)); + properties.put(1763, new CompanionProperty("external_payments_supported_business", 1763, "+917000770007", "+918369150604,+917000770007")); + properties.put(1766, new CompanionProperty("active_cart_discovery_enabled", 1766, false, true)); + properties.put(1767, new CompanionProperty("order_details_payment_options", 1767, """ + {"payment_options":[{"type":"JioPay","url_regex_list":["^https://www.jio.com/.*$","^https://t.jio/.*$","^http://tiny.jio.com/.*$"],"title":{"name":"jiopay_title","default_text":"Pay on Jio.com"},"subtitle":{"name":"jiopay_subtitle","default_text":"Go to Jio.com website"},"button":{"name":"jiopay_button","default_text":"Proceed to Jio.com"}}]}""", """ + {"payment_options":[{"type":"JioPay","url_regex_list":["^https://www.jio.com/.*$","^https://t.jio/.*$","^http://tiny.jio.com/.*$"],"title":{"name":"jiopay_title","default_text":"Pay on Jio.com"},"subtitle":{"name":"jiopay_subtitle","default_text":"Go to Jio.com website"},"button":{"name":"jiopay_button","default_text":"Proceed to Jio.com"}}]}""")); + properties.put(3014, new CompanionProperty("order_details_payment_protection_link", 3014, "https://faq.whatsapp.com/725152392426717", "https://faq.whatsapp.com/725152392426717")); + properties.put(1829, new CompanionProperty("recent_sticker_rollout_phase", 1829, 0, 0)); + properties.put(1844, new CompanionProperty("enable_client_chat_psa", 1844, false, true)); + properties.put(3182, new CompanionProperty("enable_chat_psa_auto_play_videos", 3182, false, true)); + properties.put(4033, new CompanionProperty("enable_chat_psa_forwards", 4033, false, true)); + properties.put(4659, new CompanionProperty("enable_clear_formatted_preview", 4659, false, false)); + properties.put(1846, new CompanionProperty("direct_connection_business_numbers", 1846, "16005554444,918591749310,917977079770", "16005554444,918591749310,917977079770")); + properties.put(1853, new CompanionProperty("forward_media_with_captions", 1853, false, false)); + properties.put(3177, new CompanionProperty("append_message_when_forwarding_media", 3177, false, false)); + properties.put(3875, new CompanionProperty("append_message_when_forwarding_media_without_caption", 3875, false, false)); + properties.put(4036, new CompanionProperty("view_all_replies", 4036, false, false)); + properties.put(1867, new CompanionProperty("share_phone_number_on_cart_send_to_direct_connection_biz_enabled", 1867, true, true)); + properties.put(1875, new CompanionProperty("voice_status_receipt_enabled", 1875, true, true)); + properties.put(1921, new CompanionProperty("admin_include_message_secret_in_cag", 1921, true, true)); + properties.put(1993, new CompanionProperty("md_syncd_primary_version_sync_enabled", 1993, false, false)); + properties.put(2003, new CompanionProperty("product_catalog_qpl_logging_enabled", 2003, false, true)); + properties.put(2007, new CompanionProperty("syncd_do_not_fatal_on_snapshot_mac_mismatch_in_patches", 2007, false, false)); + properties.put(2014, new CompanionProperty("graphql_locale_remapping", 2014, "{}", "{}")); + properties.put(2024, new CompanionProperty("product_catalog_qpl_direct_connection_status_logging_enabled", 2024, false, true)); + properties.put(2155, new CompanionProperty("favorite_sticker_rmr_sync_enabled", 2155, false, false)); + properties.put(2156, new CompanionProperty("web_link_preview_sync_enabled", 2156, false, true)); + properties.put(2189, new CompanionProperty("message_edit_receive", 2189, false, true)); + properties.put(2190, new CompanionProperty("message_edit_send", 2190, false, true)); + properties.put(3686, new CompanionProperty("caption_edit_receive", 3686, false, false)); + properties.put(3687, new CompanionProperty("caption_edit_send", 3687, false, false)); + properties.put(2983, new CompanionProperty("message_edit_window_duration_seconds", 2983, 1200, 1200)); + properties.put(3272, new CompanionProperty("message_edit_client_entry_point_limit_seconds", 3272, 900, 900)); + properties.put(4325, new CompanionProperty("message_edit_bubble_animation", 4325, false, false)); + properties.put(2193, new CompanionProperty("prekey_fetch_iq_for_missing_devices_enabled", 2193, false, false)); + properties.put(2306, new CompanionProperty("extensions_message_support_version", 2306, """ + {"1":{"min_android_app_supported_version":"2.22.21"},"2":{"min_android_app_supported_version":"2.22.23.11","min_ios_app_supported_version":"2.23.18.15"},"3":{"min_android_app_supported_version":"2.23.17.10","min_ios_app_supported_version":"2.23.18.15"}}""", """ + {"1":{"min_android_app_supported_version":"2.22.21"},"2":{"min_android_app_supported_version":"2.22.23","min_ios_app_supported_version":"2.23.18.15"},"3":{"min_android_app_supported_version":"2.23.17","min_ios_app_supported_version":"2.23.18.15"}}""")); + properties.put(2374, new CompanionProperty("block_from_notification", 2374, false, true)); + properties.put(2378, new CompanionProperty("four_reactions_in_bubble_enabled", 2378, false, true)); + properties.put(2522, new CompanionProperty("block_entry_point_logging_enabled", 2522, false, true)); + properties.put(2573, new CompanionProperty("non_message_data_request_logging_enabled", 2573, false, true)); + properties.put(2661, new CompanionProperty("polls_fast_follow_enabled", 2661, true, true)); + properties.put(2720, new CompanionProperty("poll_chatlist_preview_enabled", 2720, false, true)); + properties.put(2662, new CompanionProperty("polls_search_support_enabled", 2662, false, true)); + properties.put(2914, new CompanionProperty("attachment_tray_logging_enabled", 2914, false, true)); + properties.put(2663, new CompanionProperty("polls_reply_support_enabled", 2663, false, true)); + properties.put(3050, new CompanionProperty("polls_single_option_control_enabled", 3050, false, true)); + properties.put(3433, new CompanionProperty("polls_single_option_sender_control_enabled", 3433, false, true)); + properties.put(3434, new CompanionProperty("polls_single_option_reciever_control_enabled", 3434, true, true)); + properties.put(3437, new CompanionProperty("polls_single_option_receiver_control_enabled", 3437, true, true)); + properties.put(3158, new CompanionProperty("polls_notification_enabled", 3158, false, false)); + properties.put(2890, new CompanionProperty("ptt_transcription_enabled", 2890, false, true)); + properties.put(3223, new CompanionProperty("attach_menu_redesign_enabled", 3223, false, false)); + properties.put(3858, new CompanionProperty("ts_navigation_community_enabled", 3858, false, false)); + properties.put(3859, new CompanionProperty("ts_bit_array_enabled", 3859, false, false)); + properties.put(4928, new CompanionProperty("ts_external_enabled", 4928, false, false)); + properties.put(4929, new CompanionProperty("ts_surface_killswitch", 4929, 0, 0)); + properties.put(3860, new CompanionProperty("ts_session_duration_ms", 3860, 600000.0, 600000.0)); + properties.put(2776, new CompanionProperty("fullscreen_animation_for_keyword", 2776, false, false)); + properties.put(2777, new CompanionProperty("syncd_additional_mutations_count", 2777, 1, 1)); + properties.put(2811, new CompanionProperty("mpm_nfm_enabled", 2811, true, true)); + properties.put(2813, new CompanionProperty("interactive_template_enabled", 2813, true, true)); + properties.put(2871, new CompanionProperty("inapp_banner_client_enabled", 2871, false, true)); + properties.put(3712, new CompanionProperty("quick_promotion_banner_client_enabled", 3712, false, false)); + properties.put(2885, new CompanionProperty("extensions_template_killswitch", 2885, false, false)); + properties.put(2891, new CompanionProperty("biz_extensions_metadata_cache_ttl_minutes", 2891, 1440, 1440)); + properties.put(2892, new CompanionProperty("biz_extensions_metadata_ban_ttl_minutes", 2892, 525600, 525600)); + properties.put(2895, new CompanionProperty("utm_tracking_enabled", 2895, false, false)); + properties.put(2896, new CompanionProperty("utm_tracking_expiration_hours", 2896, 24, 24)); + properties.put(2909, new CompanionProperty("mpm_nfm_forwarding_enabled", 2909, false, false)); + properties.put(2990, new CompanionProperty("url_hsm_redesign_enabled", 2990, true, true)); + properties.put(2994, new CompanionProperty("button_url_hsm_redesign_enabled", 2994, true, true)); + properties.put(2945, new CompanionProperty("is_internal_tester", 2945, false, true)); + properties.put(3032, new CompanionProperty("report_string_comprehension", 3032, false, true)); + properties.put(3128, new CompanionProperty("alt_device_linking_enabled", 3128, false, false)); + properties.put(3155, new CompanionProperty("mute_dialog_description", 3155, false, true)); + properties.put(3156, new CompanionProperty("mute_always_show_notification_action", 3156, false, true)); + properties.put(3192, new CompanionProperty("extensions_graphql_cta_disable", 3192, "2498088", "2498088")); + properties.put(3198, new CompanionProperty("recent_emojis_sync", 3198, false, false)); + properties.put(3301, new CompanionProperty("syncd_report_key_stats", 3301, false, true)); + properties.put(3337, new CompanionProperty("history_sync_on_demand", 3337, false, false)); + properties.put(3642, new CompanionProperty("history_sync_on_demand_time_boundary_days", 3642, 365, 365)); + properties.put(3811, new CompanionProperty("history_sync_on_demand_message_count", 3811, 50, 50)); + properties.put(3882, new CompanionProperty("history_sync_on_demand_timeout_ms", 3882, 10000.0, 10000.0)); + properties.put(4135, new CompanionProperty("history_sync_on_demand_with_android_beta", 4135, false, false)); + properties.put(3354, new CompanionProperty("ptv_sending_enabled", 3354, false, true)); + properties.put(3355, new CompanionProperty("ptv_receiving_enabled", 3355, false, true)); + properties.put(3356, new CompanionProperty("ptv_max_duration_seconds", 3356, 60, 60)); + properties.put(3482, new CompanionProperty("ptv_autoplay_enabled", 3482, true, true)); + properties.put(3483, new CompanionProperty("ptv_autoplay_loop_limit", 3483, 3, 3)); + properties.put(4548, new CompanionProperty("ptv_nux_enabled", 4548, false, true)); + properties.put(4549, new CompanionProperty("ptv_button_persistence_enabled", 4549, false, false)); + properties.put(5292, new CompanionProperty("ptv_button_tooltip_animation_enabled", 5292, false, true)); + properties.put(5317, new CompanionProperty("ptv_button_animation_enabled", 5317, false, true)); + properties.put(5384, new CompanionProperty("ptt_button_toggle_cooldown", 5384, 0, 0)); + properties.put(5386, new CompanionProperty("ptv_button_reset_minimize_threshold", 5386, -1, -1)); + properties.put(5412, new CompanionProperty("ptv_recording_countdown_interval", 5412, 500, 500)); + properties.put(5418, new CompanionProperty("ptv_setting", 5418, false, false)); + properties.put(5419, new CompanionProperty("ptv_setting_sends_threshold", 5419, -1, -1)); + properties.put(5483, new CompanionProperty("ptv_setting_duration_threshold_seconds", 5483, 604800, 604800)); + properties.put(5507, new CompanionProperty("ptv_button_redesign_version", 5507, 0, 0)); + properties.put(3444, new CompanionProperty("template_button_improvements_on", 3444, false, true)); + properties.put(3536, new CompanionProperty("qp_campaign_client_enabled", 3536, false, false)); + properties.put(4200, new CompanionProperty("qp_push_notifications_enabled", 4200, false, false)); + properties.put(3575, new CompanionProperty("animated_emojis_enabled", 3575, false, false)); + properties.put(3579, new CompanionProperty("placeholder_message_resend", 3579, false, false)); + properties.put(3630, new CompanionProperty("is_coupon_button_enabled", 3630, false, true)); + properties.put(3631, new CompanionProperty("coupon_copy_button_url", 3631, "https://www.whatsapp.com/coupon?code=", "https://www.whatsapp.com/coupon?code=")); + properties.put(4693, new CompanionProperty("is_lto_offer_enabled", 4693, false, true)); + properties.put(5073, new CompanionProperty("lto_offer_media_aspect_ratio", 5073, 0.8, 0.8)); + properties.put(3639, new CompanionProperty("placeholder_message_resend_maximum_days_limit", 3639, 14, 14)); + properties.put(3644, new CompanionProperty("placeholder_chat_open_group_fetch", 3644, false, false)); + properties.put(3749, new CompanionProperty("placeholder_chat_open_group_fetch_size_limit", 3749, 33, 65)); + properties.put(3665, new CompanionProperty("high_quality_link_preview_enabled", 3665, false, true)); + properties.put(3690, new CompanionProperty("orders_expansion_receiver_countries_allowed", 3690, "", "")); + properties.put(3750, new CompanionProperty("retry_receipt_error_code_enabled", 3750, false, true)); + properties.put(3771, new CompanionProperty("orders_expansion_paying_enabled", 3771, false, false)); + properties.put(4089, new CompanionProperty("cag_message_edit_receive", 4089, false, false)); + properties.put(4090, new CompanionProperty("cag_message_edit_send", 4090, false, false)); + properties.put(4091, new CompanionProperty("broadcast_message_edit_receive", 4091, false, false)); + properties.put(4092, new CompanionProperty("broadcast_message_edit_send", 4092, false, false)); + properties.put(4093, new CompanionProperty("expanded_text_formatting_enabled", 4093, false, false)); + properties.put(4150, new CompanionProperty("support_ticket_data_collection_improvements", 4150, false, false)); + properties.put(4205, new CompanionProperty("link_preview_shimmer_enabled", 4205, false, false)); + properties.put(4233, new CompanionProperty("member_name_tag_enabled", 4233, false, true)); + properties.put(4242, new CompanionProperty("support_ticket_stop_uploading_device_logs", 4242, false, false)); + properties.put(4345, new CompanionProperty("community_subgroup_join_from_system_message_enabled", 4345, false, true)); + properties.put(4668, new CompanionProperty("carousel_message_client_enabled", 4668, false, true)); + properties.put(5542, new CompanionProperty("enable_carousel_message_client_logging", 5542, false, true)); + properties.put(4697, new CompanionProperty("internal_bug_reporting_v1_enabled", 4697, false, false)); + properties.put(4849, new CompanionProperty("wae_metadata_integrity_timeout_minutes", 4849, 5, 5)); + properties.put(4893, new CompanionProperty("row_buyer_order_revamp_m0_enabled", 4893, false, true)); + properties.put(5518, new CompanionProperty("row_buyer_order_revamp_m0_nux_banner_enabled", 5518, false, true)); + properties.put(4905, new CompanionProperty("post_status_in_companion", 4905, false, false)); + properties.put(4921, new CompanionProperty("evolve_about_m1_enabled", 4921, false, false)); + properties.put(4979, new CompanionProperty("community_members_bottomsheet_enabled", 4979, false, false)); + properties.put(5000, new CompanionProperty("community_members_bottomsheet_post_creation_enabled", 5000.0, false, false)); + properties.put(5114, new CompanionProperty("buyer_initiated_order_request_variant_enabled", 5114, false, false)); + properties.put(5124, new CompanionProperty("im_nfm_dynamic_message_killswitch", 5124, false, false)); + properties.put(5171, new CompanionProperty("inbox_filters_enabled", 5171, false, false)); + properties.put(5172, new CompanionProperty("inbox_filters_favorites_enabled", 5172, false, false)); + properties.put(5173, new CompanionProperty("inbox_filters_custom_filters_enabled", 5173, false, false)); + properties.put(5190, new CompanionProperty("seller_orders_management_revamp", 5190, false, false)); + properties.put(5247, new CompanionProperty("extensions_central_config_killswitch", 5247, false, false)); + properties.put(5333, new CompanionProperty("extensions_geoblocking_enabled", 5333, false, true)); + properties.put(5553, new CompanionProperty("support_ticket_device_log_retention_period_days", 5553, 3, 3)); + properties.put(5587, new CompanionProperty("bot_3p_enabled", 5587, false, false)); + properties.put(5610, new CompanionProperty("companion_biz_label_sync_enabled", 5610, false, false)); + properties.put(5626, new CompanionProperty("saga_enabled", 5626, false, false)); + properties.put(5694, new CompanionProperty("companion_biz_quick_reply_sync_enabled", 5694, false, false)); + properties.put(2575, new CompanionProperty("project_pdf_enabled", 2575, false, true)); + properties.put(3479, new CompanionProperty("pdf_auto_start_interval_seconds", 3479, 86400, 30)); + properties.put(4100, new CompanionProperty("pdf_external_deeplink_enabled", 4100, false, true)); + properties.put(4679, new CompanionProperty("pdf_client_driven_rollout_enabled", 4679, false, true)); + properties.put(4680, new CompanionProperty("pdf_max_download_jitter_time_seconds", 4680, 180, 180)); + properties.put(4779, new CompanionProperty("pdf_md_support_enabled", 4779, false, true)); + properties.put(618, new CompanionProperty("client_group_participants_limit", 618, 257, 257)); + properties.put(812, new CompanionProperty("payment_stickers_render_enabled", 812, false, false)); + properties.put(4257, new CompanionProperty("cart_order_creation_shortcut_enabled", 4257, false, false)); + properties.put(3744, new CompanionProperty("payments_merchant_global_orders_value_props_banner_enabled", 3744, false, true)); + properties.put(5255, new CompanionProperty("payments_merchant_global_orders_value_props_banner_logging_enabled", 5255, true, true)); + properties.put(4144, new CompanionProperty("payments_br_installment_buyer_learn_more_link", 4144, "https://faq.whatsapp.com/1134168457974360", "https://faq.whatsapp.com/1134168457974360")); + properties.put(4145, new CompanionProperty("ipayments_br_installment_seller_learn_more_link", 4145, "https://faq.whatsapp.com/253337763937767", "https://faq.whatsapp.com/253337763937767")); + properties.put(4254, new CompanionProperty("payments_br_installment_seller_learn_more_link", 4254, "https://faq.whatsapp.com/253337763937767", "https://faq.whatsapp.com/253337763937767")); + properties.put(5574, new CompanionProperty("seller_order_payment_request_enabled", 5574, false, false)); + properties.put(5575, new CompanionProperty("buyer_order_payment_request_enabled", 5575, false, false)); + properties.put(3051, new CompanionProperty("payments_link_to_lite_consumer_enabled", 3051, false, true)); + properties.put(4248, new CompanionProperty("payments_br_content_optimization_variant", 4248, 0, 0)); + properties.put(4781, new CompanionProperty("payments_br_pix_phase_1_seller_enabled", 4781, false, false)); + properties.put(4976, new CompanionProperty("payments_br_info_architecture_orders_hub_enabled", 4976, false, false)); + properties.put(5414, new CompanionProperty("payments_info_architecture_orders_hub_enabled", 5414, false, false)); + properties.put(808, new CompanionProperty("privacy_allow_contacts_except", 808, false, false)); + properties.put(1063, new CompanionProperty("primary_feature_sync", 1063, false, true)); + properties.put(1071, new CompanionProperty("privacy_narrative_v1", 1071, false, false)); + properties.put(1309, new CompanionProperty("add_dm_to_chat_overflow_menu", 1309, false, false)); + properties.put(1352, new CompanionProperty("keep_in_chat_receiver", 1352, false, false)); + properties.put(1353, new CompanionProperty("keep_in_chat_sender", 1353, false, false)); + properties.put(2005, new CompanionProperty("keep_in_chat_ui_content", 2005, false, false)); + properties.put(1673, new CompanionProperty("kic_orphan_cleanup_days", 1673, 31, 31)); + properties.put(2844, new CompanionProperty("supports_keep_in_chat_in_cag", 2844, true, true)); + properties.put(4042, new CompanionProperty("kic_msg_send_expiry_sec", 4042, 86400, 86400)); + properties.put(1397, new CompanionProperty("ddm_reversed_options", 1397, false, false)); + properties.put(1645, new CompanionProperty("qm_lean_msg", 1645, false, false)); + properties.put(1429, new CompanionProperty("pnh_historical_mapping_retention_seconds", 1429, 7776000.0, 7776000.0)); + properties.put(1437, new CompanionProperty("trusted_contacts_reciprocity", 1437, false, false)); + properties.put(1566, new CompanionProperty("trusted_contacts_chat_state_optimization", 1566, "old", "old")); + properties.put(1687, new CompanionProperty("trusted_contacts_op", 1687, false, true)); + properties.put(1670, new CompanionProperty("dm_updated_system_message", 1670, false, true)); + properties.put(1698, new CompanionProperty("keep_in_chat_undo_duration_limit", 1698, 2592000.0, 2592000.0)); + properties.put(1710, new CompanionProperty("view_once_sp_receiver", 1710, false, false)); + properties.put(1711, new CompanionProperty("view_once_sp_sender", 1711, false, false)); + properties.put(1823, new CompanionProperty("pnh_ctwa", 1823, false, true)); + properties.put(2245, new CompanionProperty("pnh_indicator", 2245, false, true)); + properties.put(1892, new CompanionProperty("usync_lid", 1892, false, false)); + properties.put(3062, new CompanionProperty("pnh_pn_for_lid_chat_sync", 3062, false, true)); + properties.put(2751, new CompanionProperty("pnh_identity_verification_v3", 2751, false, false)); + properties.put(3070, new CompanionProperty("share_own_pn_sync", 3070, false, true)); + properties.put(3481, new CompanionProperty("pnh_companion_history_sync_lid_chat", 3481, false, true)); + properties.put(2304, new CompanionProperty("pnh_cag_upgrade", 2304, 0, 0)); + properties.put(2035, new CompanionProperty("cag_reactions_receive", 2035, false, false)); + properties.put(2036, new CompanionProperty("cag_reactions_send", 2036, false, false)); + properties.put(2346, new CompanionProperty("pnh_cag_show_masked_members", 2346, false, false)); + properties.put(1970, new CompanionProperty("calling_privacy_caller_offer", 1970, true, true)); + properties.put(1971, new CompanionProperty("calling_privacy_caller_send_token", 1971, true, true)); + properties.put(1972, new CompanionProperty("calling_privacy_callee", 1972, true, true)); + properties.put(3624, new CompanionProperty("group_add_ack_server", 3624, true, true)); + properties.put(2433, new CompanionProperty("pnh_cag_future_proof_banner", 2433, false, false)); + properties.put(2479, new CompanionProperty("pnh_split_threads_detection", 2479, false, false)); + properties.put(3691, new CompanionProperty("pnh_ctwa_mat_crashlog", 3691, false, false)); + properties.put(2507, new CompanionProperty("pnh_group_lid", 2507, 0, 0)); + properties.put(2561, new CompanionProperty("out_of_sync_disappearing_messages_logging", 2561, false, true)); + properties.put(2597, new CompanionProperty("dm_chat_picker_v2", 2597, false, true)); + properties.put(3305, new CompanionProperty("dm_additional_durations", 3305, false, false)); + properties.put(5309, new CompanionProperty("dm_initiator_trigger", 5309, false, true)); + properties.put(2714, new CompanionProperty("ephemeral_sync_response", 2714, false, false)); + properties.put(2919, new CompanionProperty("dmcp_manage_storage_LAUNCH", 2919, false, true)); + properties.put(2800, new CompanionProperty("settings_search", 2800, false, false)); + properties.put(2802, new CompanionProperty("enable_soox_message_receiving", 2802, false, false)); + properties.put(4922, new CompanionProperty("soox_long_press_duration_ms", 4922, 500, 500)); + properties.put(2832, new CompanionProperty("enable_soox_message_sending", 2832, false, false)); + properties.put(2939, new CompanionProperty("pnh_split_thread_case1_detection", 2939, false, true)); + properties.put(2962, new CompanionProperty("pnh_cag_block_lid_in_limbo", 2962, true, true)); + properties.put(3103, new CompanionProperty("prekey_fetch_iq_pnh_lid_enabled", 3103, false, false)); + properties.put(3366, new CompanionProperty("persisted_profile_name", 3366, false, false)); + properties.put(3458, new CompanionProperty("pnh_identity_verification_v3_pn_generation", 3458, false, false)); + properties.put(3469, new CompanionProperty("pnh_1on1_lid_expected", 3469, false, true)); + properties.put(3519, new CompanionProperty("allow_lid_contacts_storage", 3519, false, false)); + properties.put(3751, new CompanionProperty("allow_lid_contacts_new_1on1_chat", 3751, false, false)); + properties.put(3752, new CompanionProperty("allow_lid_contacts_add_to_group", 3752, false, false)); + properties.put(3762, new CompanionProperty("allow_lid_contacts_calling", 3762, false, false)); + properties.put(3763, new CompanionProperty("allow_lid_contacts_privacy_settings", 3763, false, false)); + properties.put(3789, new CompanionProperty("allow_share_lid_contacts_vcard", 3789, false, false)); + properties.put(3790, new CompanionProperty("allow_parse_lid_contacts_vcard", 3790, false, false)); + properties.put(3603, new CompanionProperty("rabbit_enabled", 3603, false, false)); + properties.put(3872, new CompanionProperty("pnh_prevent_undefined_lid_chat_origin", 3872, false, false)); + properties.put(3962, new CompanionProperty("first_message_experience", 3962, false, false)); + properties.put(5263, new CompanionProperty("first_message_experience_v2", 5263, false, false)); + properties.put(4314, new CompanionProperty("privacy_tips_killswitch", 4314, false, false)); + properties.put(3995, new CompanionProperty("privacy_tips_groups_build", 3995, false, false)); + properties.put(3996, new CompanionProperty("privacy_tips_callers_build", 3996, false, false)); + properties.put(3997, new CompanionProperty("privacy_tips_status_build", 3997, false, false)); + properties.put(3998, new CompanionProperty("privacy_tips_profile_build", 3998, false, false)); + properties.put(3999, new CompanionProperty("unified_e2ee_copy_build", 3999, false, false)); + properties.put(4000, new CompanionProperty("unified_e2ee_ui_build", 4000.0, false, false)); + properties.put(4869, new CompanionProperty("unified_e2ee_copy_launch", 4869, false, false)); + properties.put(4870, new CompanionProperty("unified_e2ee_ui_launch", 4870, false, false)); + properties.put(5111, new CompanionProperty("unified_e2ee_bottomsheet", 5111, false, false)); + properties.put(5112, new CompanionProperty("unified_e2ee_security_page", 5112, false, false)); + properties.put(5113, new CompanionProperty("unified_e2ee_backup_page", 5113, false, false)); + properties.put(4131, new CompanionProperty("dm_reliability_refactor", 4131, false, false)); + properties.put(5580, new CompanionProperty("dm_reliability_logging", 5580, false, false)); + properties.put(4178, new CompanionProperty("pnh_1on1_report_lid_message_send", 4178, false, false)); + properties.put(4214, new CompanionProperty("privacy_tip_expiration_min", 4214, 10080, 10080)); + properties.put(4297, new CompanionProperty("soox_media_send_keep_old_button", 4297, false, false)); + properties.put(4495, new CompanionProperty("pnh_cag_disable_reactions_group_size", 4495, 10000.0, 10000.0)); + properties.put(5056, new CompanionProperty("pnh_cag_disable_polls_group_size", 5056, 10000.0, 10000.0)); + properties.put(4745, new CompanionProperty("username_creation", 4745, false, false)); + properties.put(4746, new CompanionProperty("username_contact_display", 4746, false, false)); + properties.put(4747, new CompanionProperty("username_change", 4747, false, false)); + properties.put(4748, new CompanionProperty("username_1on1_chat", 4748, false, false)); + properties.put(4749, new CompanionProperty("username_group_participants", 4749, false, false)); + properties.put(5290, new CompanionProperty("username_usync", 5290, false, false)); + properties.put(5189, new CompanionProperty("system_msg_update", 5189, false, false)); + properties.put(5513, new CompanionProperty("soox_vo_moving_hide_learn_more", 5513, true, false)); + properties.put(864, new CompanionProperty("sticker_md_favorite_stickers_enabled", 864, false, false)); + properties.put(1469, new CompanionProperty("smb_orange_enabled", 1469, false, false)); + properties.put(1483, new CompanionProperty("smb_melon_display_enabled", 1483, false, false)); + properties.put(1484, new CompanionProperty("smb_melon_management_enabled", 1484, false, false)); + properties.put(1525, new CompanionProperty("call_only_primary_device_limit_exceeded", 1525, false, false)); + properties.put(1591, new CompanionProperty("smb_premium_md_limit_perf_tracker_enabled", 1591, false, true)); + properties.put(1583, new CompanionProperty("smb_billing_enabled", 1583, false, false)); + properties.put(1619, new CompanionProperty("smb_billing_premium_access_config", 1619, "", "")); + properties.put(1672, new CompanionProperty("smb_billing_logging_enabled", 1672, false, true)); + properties.put(1669, new CompanionProperty("smb_melon_logging_enabled", 1669, false, true)); + properties.put(1701, new CompanionProperty("smb_dcp_enabled", 1701, false, false)); + properties.put(1849, new CompanionProperty("smb_custom_url_display_v2_enabled", 1849, false, true)); + properties.put(1438, new CompanionProperty("smb_multi_device_agents_enabled", 1438, false, true)); + properties.put(1981, new CompanionProperty("smb_multi_device_message_attribution_enabled", 1981, false, true)); + properties.put(1671, new CompanionProperty("smb_multi_device_agents_logging_enabled", 1671, false, true)); + properties.put(1897, new CompanionProperty("smb_multi_device_agents_logging_V2_enabled", 1897, false, true)); + properties.put(1798, new CompanionProperty("smb_md_agent_chat_assignment_enabled", 1798, false, true)); + properties.put(2157, new CompanionProperty("smb_md_agent_chat_assignment_system_messages_enabled", 2157, false, true)); + properties.put(2709, new CompanionProperty("smb_md_agent_chat_assignment_system_messages_logging_v2_enabled", 2709, false, true)); + properties.put(2778, new CompanionProperty("smb_md_agent_chat_assignment_system_messages_chats_reorder_enabled", 2778, false, true)); + properties.put(2787, new CompanionProperty("smb_md_agent_chat_assignment_chats_reorder_on_chat_assignment_enabled", 2787, false, true)); + properties.put(2788, new CompanionProperty("smb_md_agent_chat_assignment_chats_reorder_on_chat_unassignment_enabled", 2788, false, true)); + properties.put(2207, new CompanionProperty("smb_md_agent_chat_assignment_nux_impressions", 2207, 0, 3)); + properties.put(2976, new CompanionProperty("smb_md_agent_chat_assignment_chat_list_new_label_enabled", 2976, false, true)); + properties.put(2320, new CompanionProperty("coex_biz_states_sys_msg_enabled", 2320, false, true)); + properties.put(2582, new CompanionProperty("smb_biz_profile_custom_url", 2582, false, false)); + properties.put(2583, new CompanionProperty("smb_biz_profile_custom_url_notifications", 2583, false, false)); + properties.put(2908, new CompanionProperty("smb_md_agent_chat_assignment_notifications_enabled", 2908, false, true)); + properties.put(3046, new CompanionProperty("smb_marketing_messages_enabled", 3046, false, true)); + properties.put(3113, new CompanionProperty("smb_marketing_messages_product_ids", 3113, "", "")); + properties.put(3124, new CompanionProperty("smb_rambutan_enabled", 3124, false, true)); + properties.put(3125, new CompanionProperty("smb_rambutan_product_ids", 3125, "", "")); + properties.put(4005, new CompanionProperty("smb_premium_messages_spam_report_enabled", 4005, false, true)); + properties.put(4596, new CompanionProperty("web_premium_messages_interactivity_rendering_enabled", 4596, false, true)); + properties.put(4657, new CompanionProperty("smb_premium_messages_click_logging_enabled", 4657, false, true)); + properties.put(4942, new CompanionProperty("smba_premium_messages_interactivity_catalog_cta_consumer_enabled", 4942, false, true)); + properties.put(4957, new CompanionProperty("smb_premium_messages_interactivity_catalog_cta_consumer_enabled", 4957, false, true)); + properties.put(5044, new CompanionProperty("smb_premium_messages_url_cta_alert_dialog_enabled", 5044, true, true)); + properties.put(5318, new CompanionProperty("premium_blue_enabled", 5318, false, false)); + properties.put(5276, new CompanionProperty("blue_enabled", 5276, false, false)); + properties.put(5295, new CompanionProperty("blue_education_enabled", 5295, false, false)); + properties.put(5277, new CompanionProperty("newsletter_blue_enabled", 5277, false, false)); + properties.put(5296, new CompanionProperty("newsletter_blue_education_enabled", 5296, false, false)); + properties.put(2249, new CompanionProperty("mex_phase3_enabled", 2249, false, false)); + properties.put(2250, new CompanionProperty("mex_phase3_status_flags", 2250, 0, 0)); + properties.put(3604, new CompanionProperty("mex_newsletter_killswitch", 3604, false, false)); + properties.put(5437, new CompanionProperty("mex_native_client_enabled", 5437, false, false)); + properties.put(3605, new CompanionProperty("mex_newsletter_flags", 3605, 0, 0)); + properties.put(2980, new CompanionProperty("groove_enabled_web", 2980, false, false)); + properties.put(3385, new CompanionProperty("newsletter_enabled", 3385, false, false)); + properties.put(3020, new CompanionProperty("newsletter_enabled_web", 3020, false, false)); + properties.put(3148, new CompanionProperty("newsletter_reporting_enabled", 3148, false, true)); + properties.put(3149, new CompanionProperty("newsletter_suspend_enabled", 3149, false, true)); + properties.put(4219, new CompanionProperty("channels_restricted_updates_enabled", 4219, false, true)); + properties.put(5161, new CompanionProperty("channels_geosuspend_enabled", 5161, false, true)); + properties.put(5216, new CompanionProperty("channels_geosuspend_admin_alerts_enabled", 5216, false, true)); + properties.put(5621, new CompanionProperty("channel_info_admin_metadata_fetching_enabled", 5621, false, true)); + properties.put(3209, new CompanionProperty("allow_nl_linkpreview", 3209, true, true)); + properties.put(3607, new CompanionProperty("newsletter_creation_enabled", 3607, false, false)); + properties.put(3778, new CompanionProperty("newsletter_media_autodownload_mode", 3778, 3, 3)); + properties.put(4369, new CompanionProperty("newsletter_media_autodownload_jitter_multiplier", 4369, 5000.0, 1000.0)); + properties.put(4370, new CompanionProperty("newsletter_media_autodownload_queue_max_concurrency", 4370, 5, 5)); + properties.put(4479, new CompanionProperty("newsletter_media_priority_queue_incoming_max_size", 4479, 32, 32)); + properties.put(3617, new CompanionProperty("nl_df_gid", 3617, "", "")); + properties.put(3618, new CompanionProperty("nl_crt_df_gid", 3618, "", "120363080354356818")); + properties.put(3810, new CompanionProperty("newsletter_tos_notice_id", 3810, "20601216", "20601216")); + properties.put(5448, new CompanionProperty("newsletter_tos_notice_version", 5448, 1, 1)); + properties.put(3834, new CompanionProperty("newsletter_creation_tos_id", 3834, "20601217", "20601217")); + properties.put(5449, new CompanionProperty("newsletter_creation_tos_version", 5449, "20601217", "20601217")); + properties.put(5456, new CompanionProperty("newsletter_creation_tos_version_v2", 5456, 1, 1)); + properties.put(3835, new CompanionProperty("newsletter_creation_nux_id", 3835, "20601218", "20601218")); + properties.put(5450, new CompanionProperty("newsletter_creation_nux_version", 5450, "20601218", "20601218")); + properties.put(5457, new CompanionProperty("newsletter_creation_nux_version_v2", 5457, 1, 1)); + properties.put(5597, new CompanionProperty("newsletter_tos_notice_id_smb_web", 5597, "20601216", "20601216")); + properties.put(5598, new CompanionProperty("newsletter_creation_tos_id_smb_web", 5598, "20601217", "20601217")); + properties.put(3877, new CompanionProperty("channels_enabled", 3877, 0, 0)); + properties.put(3878, new CompanionProperty("channels_creation_enabled", 3878, 0, 2)); + properties.put(3879, new CompanionProperty("channels_directory_enabled", 3879, 0, 2)); + properties.put(4356, new CompanionProperty("channels_recommended_enabled", 4356, 0, 2)); + properties.put(4590, new CompanionProperty("channels_view_counts_enabled", 4590, false, true)); + properties.put(4721, new CompanionProperty("channel_view_counts_enabled", 4721, 0, 3)); + properties.put(4648, new CompanionProperty("channel_views_duration_milliseconds", 4648, 1000.0, 1000.0)); + properties.put(4722, new CompanionProperty("channel_playable_message_views_duration_milliseconds", 4722, 3000.0, 3000.0)); + properties.put(4271, new CompanionProperty("channels_recommended_cache_ttl_ms", 4271, 6.048E8, 8.64E7)); + properties.put(3880, new CompanionProperty("show_channels_not_available_dialog", 3880, false, true)); + properties.put(3900, new CompanionProperty("newsletter_supported_message_types", 3900, """ + {"supported": [1, 2, 3, 9]}""", """ + {"supported": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]}""")); + properties.put(3919, new CompanionProperty("channel_supported_message_types", 3919, "1, 2, 3, 9, 10", "1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15")); + properties.put(4282, new CompanionProperty("directory_sort_kill_switch", 4282, true, true)); + properties.put(4283, new CompanionProperty("directory_search_kill_switch", 4283, true, true)); + properties.put(5303, new CompanionProperty("channels_directory_v2_cache_ttl_ms", 5303, 7200000.0, 3600000.0)); + properties.put(5304, new CompanionProperty("channels_directory_v2_cache_refresh_interval_ms", 5304, 1800000.0, 600000.0)); + properties.put(4306, new CompanionProperty("channel_reactions_enabled", 4306, false, true)); + properties.put(4633, new CompanionProperty("channel_reactions_sending_enabled", 4633, false, true)); + properties.put(4887, new CompanionProperty("channel_reactions_settings_enabled", 4887, false, true)); + properties.put(5274, new CompanionProperty("channel_reactions_settings_none_option_enabled", 5274, false, false)); + properties.put(5185, new CompanionProperty("channel_reactions_sender_list_enabled", 5185, false, true)); + properties.put(4699, new CompanionProperty("reactions_allowlisted_channels", 4699, "", "120363144141162927,120363160538286018")); + properties.put(4307, new CompanionProperty("channel_follower_list_enabled", 4307, false, true)); + properties.put(5182, new CompanionProperty("channels_followers_list_cache_refresh_seconds", 5182, 60, 60)); + properties.put(5217, new CompanionProperty("channels_followers_list_cache_refresh_milliseconds", 5217, 60000.0, 60000.0)); + properties.put(4308, new CompanionProperty("recommended_channels_cache_max_ttl", 4308, 0, 0)); + properties.put(4309, new CompanionProperty("recommended_channels_background_refresh", 4309, 1.44E7, 1800000.0)); + properties.put(4326, new CompanionProperty("channel_pull_message_updates_threshold_seconds", 4326, 120, 120)); + properties.put(4338, new CompanionProperty("channel_forward_to_chat_enabled", 4338, false, true)); + properties.put(4860, new CompanionProperty("channel_forward_to_chat_link_enabled", 4860, false, true)); + properties.put(4357, new CompanionProperty("channels_waitlist_enabled", 4357, false, true)); + properties.put(4506, new CompanionProperty("channels_updates_tab_logging_enabled", 4506, false, true)); + properties.put(4632, new CompanionProperty("channels_waitlist_logging_enabled", 4632, false, true)); + properties.put(4635, new CompanionProperty("channels_dyi_enabled", 4635, false, true)); + properties.put(4866, new CompanionProperty("channels_dyi_max_file_size_in_bytes_warning_threshold", 4866, 1.0E9, 1.0E9)); + properties.put(5488, new CompanionProperty("channels_dyi_logging_enabled", 5488, false, true)); + properties.put(4644, new CompanionProperty("channel_forward_to_chat_v2_enabled", 4644, false, false)); + properties.put(4653, new CompanionProperty("channels_large_number_format_enabled", 4653, false, true)); + properties.put(4682, new CompanionProperty("channel_forward_to_chat_v2_message_navigation_enabled", 4682, false, true)); + properties.put(4683, new CompanionProperty("channel_forward_to_chat_v2_new_ui_enabled", 4683, false, true)); + properties.put(4684, new CompanionProperty("channels_view_counts_display_to_followers_enabled", 4684, false, true)); + properties.put(4760, new CompanionProperty("channels_send_view_receipt_enabled", 4760, false, true)); + properties.put(4782, new CompanionProperty("channels_forwarding_logging_enabled", 4782, false, true)); + properties.put(4783, new CompanionProperty("channels_directory_logging_enabled", 4783, false, true)); + properties.put(4784, new CompanionProperty("channels_creation_logging_enabled", 4784, false, true)); + properties.put(5015, new CompanionProperty("channels_filter_out_subscribed_in_directory_null_state", 5015, false, true)); + properties.put(5040, new CompanionProperty("ts_navigation_channels_enabled", 5040, false, true)); + properties.put(5262, new CompanionProperty("channel_core_event_logging_enabled", 5262, false, true)); + properties.put(5041, new CompanionProperty("channel_link_in_nav_bar_enabled", 5041, false, true)); + properties.put(5096, new CompanionProperty("channels_recommended_v2_ui_enabled", 5096, false, true)); + properties.put(5464, new CompanionProperty("channels_recommended_v2_recently_followed_channels_below_enabled", 5464, false, true)); + properties.put(5126, new CompanionProperty("channels_directory_v2_enabled", 5126, false, true)); + properties.put(5127, new CompanionProperty("channels_directory_v2_filter_types", 5127, "", "1, 2, 3, 4, 5, 6")); + properties.put(5158, new CompanionProperty("channels_admin_context_card_enabled", 5158, false, true)); + properties.put(5174, new CompanionProperty("channels_message_edit_enabled", 5174, false, true)); + properties.put(5188, new CompanionProperty("channels_message_link_enabled", 5188, false, true)); + properties.put(5203, new CompanionProperty("channels_directory_fetch_limit", 5203, 50, 50)); + properties.put(5204, new CompanionProperty("channels_directory_search_debounce_ms", 5204, 250, 250)); + properties.put(5205, new CompanionProperty("recommended_channels_fetch_limit", 5205, 20, 20)); + properties.put(5208, new CompanionProperty("channels_edit_backwards_compatibility", 5208, false, true)); + properties.put(5287, new CompanionProperty("channels_hide_news_url_preview", 5287, false, true)); + properties.put(5402, new CompanionProperty("large_number_format_uses_generic_plural", 5402, true, true)); + properties.put(5471, new CompanionProperty("channels_directory_v2_logging_enabled", 5471, false, true)); + properties.put(5491, new CompanionProperty("channels_share_link_logging_enabled", 5491, false, true)); + properties.put(5492, new CompanionProperty("channels_forward_logging_v2_enabled", 5492, false, true)); + properties.put(5487, new CompanionProperty("channels_directory_pagination_enabled", 5487, false, true)); + properties.put(5489, new CompanionProperty("updates_tab_open_channels_fields_logging_enabled", 5489, false, true)); + properties.put(5494, new CompanionProperty("channels_max_messages_batch_pull", 5494, 100, 100)); + properties.put(5511, new CompanionProperty("channels_hq_link_preview", 5511, false, false)); + properties.put(5533, new CompanionProperty("channels_poll_creation_enabled", 5533, false, true)); + properties.put(5534, new CompanionProperty("channels_poll_single_option_control_enable", 5534, false, true)); + properties.put(5551, new CompanionProperty("channels_web_bootstrap_timeout_enabled", 5551, false, true)); + properties.put(5625, new CompanionProperty("channels_media_cache_setting_enabled", 5625, false, false)); + properties.put(5643, new CompanionProperty("channels_send_album_enabled", 5643, false, true)); + properties.put(5646, new CompanionProperty("channels_message_loading_indicators_enabled", 5646, false, true)); + properties.put(3710, new CompanionProperty("otp_ttl_inject_receipt_enabled", 3710, false, true)); + properties.put(3827, new CompanionProperty("unified_otp_copy_code_url", 3827, "https://www.whatsapp.com/otp/copy/", "https://www.whatsapp.com/otp/copy/")); + properties.put(3828, new CompanionProperty("unified_otp_retriever_url", 3828, "https://www.whatsapp.com/otp/code", "https://www.whatsapp.com/otp/code")); + properties.put(4330, new CompanionProperty("web_otp_copy_code_disabled", 4330, false, false)); + properties.put(3514, new CompanionProperty("lid_groups_ougtoing_explict_address_mode", 3514, false, true)); + properties.put(3615, new CompanionProperty("lid_groups_outgoing_explict_address_mode", 3615, false, true)); + properties.put(3645, new CompanionProperty("lid_groups_new_group_creation", 3645, false, false)); + properties.put(3688, new CompanionProperty("lid_groups_handle_server_addressing_mode", 3688, false, false)); + properties.put(3876, new CompanionProperty("lid_groups_create_lid_individual_chats", 3876, false, false)); + properties.put(3803, new CompanionProperty("lid_groups_outgoing_explicit_address_mode", 3803, false, true)); + properties.put(3804, new CompanionProperty("lid_groups_aggregate_participant_change_system_message", 3804, false, false)); + properties.put(4162, new CompanionProperty("lid_groups_message_send_validation", 4162, false, true)); + properties.put(4476, new CompanionProperty("pnh_copy_identity_keys_and_devices", 4476, false, true)); + properties.put(4533, new CompanionProperty("pnh_sync_identity_keys_and_devices", 4533, false, true)); + properties.put(5555, new CompanionProperty("invalid_hosted_companion_nack_enabled", 5555, false, true)); + properties.put(5623, new CompanionProperty("lid_outgoing_msg_attach_meta_tag", 5623, false, false)); + properties.put(3180, new CompanionProperty("group_suspend_v2_enabled", 3180, false, true)); + properties.put(3988, new CompanionProperty("enable_status_report_and_block", 3988, false, true)); + properties.put(5245, new CompanionProperty("report_block_classification_logging_enabled", 5245, false, true)); + properties.put(5716, new CompanionProperty("rt_validate_message_type", 5716, false, false)); + properties.put(5717, new CompanionProperty("rt_send_reporting_tag", 5717, false, false)); + properties.put(5718, new CompanionProperty("rt_receive_reporting_tag", 5718, false, false)); + properties.put(3471, new CompanionProperty("df_config", 3471, "", "")); + properties.put(3472, new CompanionProperty("df_enabled", 3472, false, false)); + properties.put(4873, new CompanionProperty("wabai_message_rendering_enabled", 4873, false, false)); + properties.put(5215, new CompanionProperty("wabai_message_feedback_enabled", 5215, false, false)); + properties.put(5224, new CompanionProperty("wabai_marketing_message_content_gen_enabled", 5224, false, false)); + properties.put(5330, new CompanionProperty("ctwa_content_gen_enabled", 5330, false, false)); + //noinspection Java9CollectionFactory + PROPERTIES = Collections.unmodifiableMap(properties); + } + + public static boolean anyMatch(String input, String regex) { + return Pattern.compile(regex) + .matcher(input) + .results() + .findAny() + .isPresent(); + } +} diff --git a/src/main/java/it/auties/whatsapp/controller/Controller.java b/src/main/java/it/auties/whatsapp/controller/Controller.java new file mode 100644 index 000000000..f1d5e5e4a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/controller/Controller.java @@ -0,0 +1,169 @@ +package it.auties.whatsapp.controller; + +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.model.mobile.PhoneNumber; +import it.auties.whatsapp.util.Json; +import it.auties.whatsapp.util.ProtobufUuidMixin; + +import java.util.*; + +/** + * This interface represents is implemented by all WhatsappWeb4J's controllers. It provides an easy + * way to store IDs and serialize said class. + */ +@SuppressWarnings("unused") +public abstract sealed class Controller> implements ProtobufMessage permits Store, Keys { + /** + * The id of this controller + */ + @ProtobufProperty(index = 1, type = ProtobufType.STRING, mixin = ProtobufUuidMixin.class) + protected final UUID uuid; + + /** + * The phone number of the associated companion + */ + @ProtobufProperty(index = 2, type = ProtobufType.UINT64) + private PhoneNumber phoneNumber; + + /** + * The serializer instance to use + */ + @JsonIgnore + protected ControllerSerializer serializer; + + /** + * The client type + */ + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + protected final ClientType clientType; + + /** + * A list of alias for the controller, can be used in place of UUID1 + */ + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + protected final Collection alias; + + public Controller(UUID uuid, PhoneNumber phoneNumber, ControllerSerializer serializer, ClientType clientType, Collection alias) { + this.uuid = Objects.requireNonNull(uuid, "Missing uuid"); + this.phoneNumber = phoneNumber; + this.serializer = serializer; + this.clientType = clientType; + this.alias = Objects.requireNonNullElseGet(alias, ArrayList::new); + } + + /** + * Serializes this object + * + * @param async whether the operation should be executed asynchronously + */ + public abstract void serialize(boolean async); + + /** + * Disposes this object + */ + public abstract void dispose(); + + public UUID uuid() { + return uuid; + } + + public ClientType clientType() { + return this.clientType; + } + + /** + * Returns the phone number of this controller + * + * @return an optional + */ + public Optional phoneNumber() { + return Optional.ofNullable(phoneNumber); + } + + /** + * Sets the phone number used by this session + * + * @return the same instance + */ + @SuppressWarnings("unchecked") + public T setPhoneNumber(PhoneNumber phoneNumber) { + this.phoneNumber = phoneNumber; + serializer.linkMetadata(this); + return (T) this; + } + + /** + * Returns the serializer + * + * @return a non-null serializer + */ + public ControllerSerializer serializer() { + return serializer; + } + + /** + * Sets the serializer of this controller + * + * @param serializer a serializer + * @return the same instance + */ + @SuppressWarnings("unchecked") + public T setSerializer(ControllerSerializer serializer) { + this.serializer = serializer; + return (T) this; + } + + /** + * Returns an immutable collection of alias + * + * @return an immutable collection + */ + public Collection alias() { + return Collections.unmodifiableCollection(alias); + } + + /** + * Adds an alias to this controller + * + * @param entry the non-null alias to add + */ + public void addAlias(String entry) { + alias.add(entry); + } + + /** + * Removes an alias to this controller + * + * @param entry the non-null alias to remove + */ + public void removeAlias(String entry) { + alias.remove(entry); + } + + /** + * Removes all alias from this controller + */ + public void removeAlias() { + alias.clear(); + } + + /** + * Converts this controller to a json. Useful when debugging. + * + * @return a non-null string + */ + public String toJson() { + return Json.writeValueAsString(this, true); + } + + /** + * Deletes the current session + */ + public void deleteSession() { + serializer.deleteSession(this); + } +} diff --git a/src/main/java/it/auties/whatsapp/controller/ControllerSerializer.java b/src/main/java/it/auties/whatsapp/controller/ControllerSerializer.java new file mode 100644 index 000000000..790ac015a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/controller/ControllerSerializer.java @@ -0,0 +1,246 @@ +package it.auties.whatsapp.controller; + +import it.auties.whatsapp.api.ClientType; +import it.auties.whatsapp.model.mobile.PhoneNumber; + +import java.nio.file.Path; +import java.util.Collection; +import java.util.LinkedList; +import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.CompletableFuture; + +/** + * This interface provides a standardized way to serialize a session + */ +@SuppressWarnings("unused") +public interface ControllerSerializer { + /** + * Returns the default serializer + * This implementation uses .proto files compressed using gzip + * + * @return a serializer + */ + static ControllerSerializer discarding() { + return DiscardingControllerSerializer.singleton(); + } + + /** + * Returns the default serializer + * This implementation uses .proto files compressed using gzip + * + * @return a serializer + */ + static ControllerSerializer toProtobuf() { + return ProtobufControllerSerializer.ofDefaultPath(); + } + + /** + * Returns the default serializer + * This implementation uses .proto files compressed using gzip + * + * @param baseDirectory the directory where all the sessions should be saved + * @return a serializer + */ + static ControllerSerializer toProtobuf(Path baseDirectory) { + return ProtobufControllerSerializer.of(baseDirectory); + } + + /** + * Returns all the known IDs + * + * @param type the non-null type of client + * @return a non-null linked list + */ + LinkedList listIds(ClientType type); + + /** + * Returns all the known IDs + * + * @param type the non-null type of client + * @return a non-null linked list + */ + LinkedList listPhoneNumbers(ClientType type); + + /** + * Creates a fresh pair of store and keys + * + * @param uuid the non-null uuid + * @param phoneNumber the nullable phone number + * @param alias the nullable alias + * @param clientType the non-null client type + * @return a non-null store-keys pair + */ + default StoreKeysPair newStoreKeysPair(UUID uuid, Long phoneNumber, Collection alias, ClientType clientType) { + var store = Store.newStore(uuid, phoneNumber, alias, clientType); + store.setSerializer(this); + linkMetadata(store); + var keys = Keys.newKeys(uuid, phoneNumber, alias, clientType); + keys.setSerializer(this); + serializeKeys(keys, true); + return new StoreKeysPair(store, keys); + } + + /** + * Deserializes a store-keys pair from a list of possible identifiers + * + * @param uuid the nullable identifying unique id + * @param phoneNumber the nullable identifying phone number + * @param alias the nullable identifying alias + * @param clientType the non-null client type + * @return an optional store-keys pair + */ + default Optional deserializeStoreKeysPair(UUID uuid, Long phoneNumber, String alias, ClientType clientType) { + if (uuid != null) { + var store = deserializeStore(clientType, uuid); + if(store.isEmpty()) { + return Optional.empty(); + } + + store.get().setSerializer(this); + attributeStore(store.get()); + var keys = deserializeKeys(clientType, uuid); + if(keys.isEmpty()) { + return Optional.empty(); + } + + keys.get().setSerializer(this); + return Optional.of(new StoreKeysPair(store.get(), keys.get())); + } + + if (phoneNumber != null) { + var store = deserializeStore(clientType, phoneNumber); + if(store.isEmpty()) { + return Optional.empty(); + } + + store.get().setSerializer(this); + attributeStore(store.get()); + var keys = deserializeKeys(clientType, phoneNumber); + if(keys.isEmpty()) { + return Optional.empty(); + } + + keys.get().setSerializer(this); + return Optional.of(new StoreKeysPair(store.get(), keys.get())); + } + + if (alias != null) { + var store = deserializeStore(clientType, alias); + if(store.isEmpty()) { + return Optional.empty(); + } + + store.get().setSerializer(this); + attributeStore(store.get()); + var keys = deserializeKeys(clientType, alias); + if(keys.isEmpty()) { + return Optional.empty(); + } + + keys.get().setSerializer(this); + return Optional.of(new StoreKeysPair(store.get(), keys.get())); + } + + return Optional.empty(); + } + + /** + * Serializes the keys + * + * @param keys the non-null keys to serialize + * @param async whether the operation should be executed asynchronously + */ + CompletableFuture serializeKeys(Keys keys, boolean async); + + /** + * Serializes the store + * + * @param store the non-null store to serialize + * @param async whether the operation should be executed asynchronously + */ + CompletableFuture serializeStore(Store store, boolean async); + + /** + * Serializes the keys + * + * @param type the non-null type of client + * @param id the id of the keys + * @return a non-null keys + */ + Optional deserializeKeys(ClientType type, UUID id); + + /** + * Serializes the keys + * + * @param type the non-null type of client + * @param phoneNumber the phone number of the keys + * @return a non-null keys + */ + Optional deserializeKeys(ClientType type, long phoneNumber); + + + /** + * Serializes the keys + * + * @param type the non-null type of client + * @param alias the alias number of the keys + * @return a non-null keys + */ + Optional deserializeKeys(ClientType type, String alias); + + /** + * Serializes the store + * + * @param type the non-null type of client + * @param id the id of the store + * @return a non-null store + */ + Optional deserializeStore(ClientType type, UUID id); + + /** + * Serializes the store + * + * @param type the non-null type of client + * @param phoneNumber the phone number of the store + * @return a non-null store + */ + Optional deserializeStore(ClientType type, long phoneNumber); + + /** + * Serializes the store + * + * @param type the non-null type of client + * @param alias the alias of the store + * @return a non-null store + */ + Optional deserializeStore(ClientType type, String alias); + + /** + * Deletes a session + * + * @param controller the non-null controller + */ + void deleteSession(Controller controller); + + /** + * Creates a link between the session and its metadata, usually phone number and alias + * + * @param controller a non-null controller + */ + default void linkMetadata(Controller controller) { + + } + + /** + * Attributes the store asynchronously. This method is optionally used to load asynchronously + * heavy data such as chats while the socket is connecting. If implemented, cache the returning + * newsletters because the method may be called multiple times. + * + * @param store the non-null store to attribute + * @return a completable newsletters + */ + default CompletableFuture attributeStore(Store store) { + return CompletableFuture.completedFuture(null); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/controller/DiscardingControllerSerializer.java b/src/main/java/it/auties/whatsapp/controller/DiscardingControllerSerializer.java new file mode 100644 index 000000000..a045b02fd --- /dev/null +++ b/src/main/java/it/auties/whatsapp/controller/DiscardingControllerSerializer.java @@ -0,0 +1,78 @@ +package it.auties.whatsapp.controller; + +import it.auties.whatsapp.api.ClientType; +import it.auties.whatsapp.model.mobile.PhoneNumber; + +import java.util.LinkedList; +import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.CompletableFuture; +class DiscardingControllerSerializer implements ControllerSerializer { + private static final DiscardingControllerSerializer SINGLETON = new DiscardingControllerSerializer(); + private static final LinkedList EMPTY_IDS = new LinkedList<>(); + private static final LinkedList EMPTY_PHONE_NUMBERS = new LinkedList<>(); + + public static ControllerSerializer singleton() { + return SINGLETON; + } + + @Override + public LinkedList listIds(ClientType type) { + return EMPTY_IDS; + } + + @Override + public LinkedList listPhoneNumbers(ClientType type) { + return EMPTY_PHONE_NUMBERS; + } + + @Override + public Optional deserializeStoreKeysPair(UUID uuid, Long phoneNumber, String alias, ClientType clientType) { + return Optional.empty(); + } + + @Override + public CompletableFuture serializeKeys(Keys keys, boolean async) { + return CompletableFuture.completedFuture(null); + } + + @Override + public CompletableFuture serializeStore(Store store, boolean async) { + return CompletableFuture.completedFuture(null); + } + + @Override + public Optional deserializeKeys(ClientType type, UUID id) { + return Optional.empty(); + } + + @Override + public Optional deserializeKeys(ClientType type, long phoneNumber) { + return Optional.empty(); + } + + @Override + public Optional deserializeKeys(ClientType type, String alias) { + return Optional.empty(); + } + + @Override + public Optional deserializeStore(ClientType type, UUID id) { + return Optional.empty(); + } + + @Override + public Optional deserializeStore(ClientType type, long phoneNumber) { + return Optional.empty(); + } + + @Override + public Optional deserializeStore(ClientType type, String alias) { + return Optional.empty(); + } + + @Override + public void deleteSession(Controller controller) { + + } +} diff --git a/src/main/java/it/auties/whatsapp/controller/Keys.java b/src/main/java/it/auties/whatsapp/controller/Keys.java new file mode 100644 index 000000000..88c31c076 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/controller/Keys.java @@ -0,0 +1,684 @@ +package it.auties.whatsapp.controller; + +import com.fasterxml.jackson.annotation.JsonCreator; +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.model.companion.CompanionHashState; +import it.auties.whatsapp.model.companion.CompanionPatch; +import it.auties.whatsapp.model.companion.CompanionSyncKey; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.mobile.PhoneNumber; +import it.auties.whatsapp.model.signal.auth.SignedDeviceIdentity; +import it.auties.whatsapp.model.signal.auth.SignedDeviceIdentityHMAC; +import it.auties.whatsapp.model.signal.keypair.SignalKeyPair; +import it.auties.whatsapp.model.signal.keypair.SignalPreKeyPair; +import it.auties.whatsapp.model.signal.keypair.SignalSignedKeyPair; +import it.auties.whatsapp.model.signal.sender.SenderKeyName; +import it.auties.whatsapp.model.signal.sender.SenderKeyRecord; +import it.auties.whatsapp.model.signal.sender.SenderPreKeys; +import it.auties.whatsapp.model.signal.session.Session; +import it.auties.whatsapp.model.signal.session.SessionAddress; +import it.auties.whatsapp.model.sync.AppStateSyncKey; +import it.auties.whatsapp.model.sync.PatchType; +import it.auties.whatsapp.util.Bytes; +import it.auties.whatsapp.util.Clock; +import it.auties.whatsapp.util.ProtobufUuidMixin; + +import java.util.*; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ThreadLocalRandom; +import java.util.concurrent.atomic.AtomicLong; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import static java.util.Objects.requireNonNullElseGet; + +/** + * This controller holds the cryptographic-related data regarding a WhatsappWeb session + */ +@SuppressWarnings({"unused", "UnusedReturnValue"}) +public final class Keys extends Controller implements ProtobufMessage { + /** + * The client id + */ + @ProtobufProperty(index = 5, type = ProtobufType.INT32) + final Integer registrationId; + + /** + * The secret key pair used for buffer messages + */ + @ProtobufProperty(index = 6, type = ProtobufType.OBJECT) + final SignalKeyPair noiseKeyPair; + + /** + * The ephemeral key pair + */ + @ProtobufProperty(index = 7, type = ProtobufType.OBJECT) + final SignalKeyPair ephemeralKeyPair; + + /** + * The signed identity key + */ + @ProtobufProperty(index = 8, type = ProtobufType.OBJECT) + final SignalKeyPair identityKeyPair; + + /** + * The companion secret key + */ + @ProtobufProperty(index = 9, type = ProtobufType.OBJECT) + SignalKeyPair companionKeyPair; + + /** + * The signed pre key + */ + @ProtobufProperty(index = 10, type = ProtobufType.OBJECT) + final SignalSignedKeyPair signedKeyPair; + + /** + * The signed key of the companion's device + * This value will be null until it gets synced by whatsapp + */ + @ProtobufProperty(index = 11, type = ProtobufType.BYTES) + byte[] signedKeyIndex; + + /** + * The timestampSeconds of the signed key companion's device + */ + @ProtobufProperty(index = 12, type = ProtobufType.UINT64) + Long signedKeyIndexTimestamp; + + /** + * Whether these keys have generated pre keys assigned to them + */ + @ProtobufProperty(index = 13, type = ProtobufType.OBJECT) + final List preKeys; + + /** + * The phone id for the mobile api + */ + @ProtobufProperty(index = 14, type = ProtobufType.STRING) + final String fdid; + + /** + * The device id for the mobile api + */ + @ProtobufProperty(index = 15, type = ProtobufType.BYTES) + final byte[] deviceId; + + @ProtobufProperty(index = 26, type = ProtobufType.STRING, mixin = ProtobufUuidMixin.class) + final UUID advertisingId; + + /** + * The recovery token for the mobile api + */ + @ProtobufProperty(index = 16, type = ProtobufType.BYTES) + final byte[] identityId; + + /** + * The bytes of the encoded {@link SignedDeviceIdentityHMAC} received during the auth process + */ + @ProtobufProperty(index = 17, type = ProtobufType.OBJECT) + SignedDeviceIdentity companionIdentity; + + /** + * Sender keys for signal implementation + */ + @ProtobufProperty(index = 18, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.OBJECT) + final Map senderKeys; + + /** + * App state keys + */ + @ProtobufProperty(index = 19, type = ProtobufType.OBJECT) + final List appStateKeys; + + /** + * Sessions map + */ + @ProtobufProperty(index = 20, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.OBJECT) + final Map sessions; + + /** + * Hash state + */ + @ProtobufProperty(index = 21, type = ProtobufType.OBJECT) + final List hashStates; + + + @ProtobufProperty(index = 22, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.OBJECT) + final Map groupsPreKeys; + + /** + * Whether the client was registered + */ + @ProtobufProperty(index = 23, type = ProtobufType.BOOL) + boolean registered; + + /** + * Whether the client has already sent its business certificate (mobile api only) + */ + @ProtobufProperty(index = 24, type = ProtobufType.BOOL) + boolean businessCertificate; + + /** + * Whether the client received the initial app sync (web api only) + */ + @ProtobufProperty(index = 25, type = ProtobufType.BOOL) + boolean initialAppSync; + + /** + * Write counter for IV + */ + @JsonIgnore + final AtomicLong writeCounter; + + /** + * Read counter for IV + */ + @JsonIgnore + final AtomicLong readCounter; + + /** + * Session dependent keys to write and read cyphered messages + */ + @JsonIgnore + byte[] writeKey, readKey; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public Keys(UUID uuid, PhoneNumber phoneNumber, ClientType clientType, Collection alias, Integer registrationId, SignalKeyPair noiseKeyPair, SignalKeyPair ephemeralKeyPair, SignalKeyPair identityKeyPair, SignalKeyPair companionKeyPair, SignalSignedKeyPair signedKeyPair, byte[] signedKeyIndex, Long signedKeyIndexTimestamp, List preKeys, String fdid, byte[] deviceId, UUID advertisingId, byte[] identityId, SignedDeviceIdentity companionIdentity, Map senderKeys, List appStateKeys, Map sessions, List hashStates, Map groupsPreKeys, boolean registered, boolean businessCertificate, boolean initialAppSync) { + super(uuid, phoneNumber, null, clientType, alias); + this.registrationId = Objects.requireNonNullElseGet(registrationId, () -> ThreadLocalRandom.current().nextInt(16380) + 1); + this.noiseKeyPair = Objects.requireNonNull(noiseKeyPair, "Missing noise keypair"); + this.ephemeralKeyPair = Objects.requireNonNullElseGet(ephemeralKeyPair, SignalKeyPair::random); + this.identityKeyPair = Objects.requireNonNull(identityKeyPair, "Missing identity keypair"); + this.companionKeyPair = Objects.requireNonNullElseGet(companionKeyPair, SignalKeyPair::random); + this.signedKeyPair = Objects.requireNonNullElseGet(signedKeyPair, () -> SignalSignedKeyPair.of(this.registrationId, identityKeyPair)); + this.signedKeyIndex = signedKeyIndex; + this.signedKeyIndexTimestamp = signedKeyIndexTimestamp; + this.preKeys = Objects.requireNonNullElseGet(preKeys, ArrayList::new); + this.fdid = Objects.requireNonNullElseGet(fdid, UUID.randomUUID()::toString); + this.deviceId = Objects.requireNonNullElseGet(deviceId, () -> HexFormat.of().parseHex(UUID.randomUUID().toString().replaceAll("-", ""))); + this.advertisingId = Objects.requireNonNullElseGet(advertisingId, UUID::randomUUID); + this.identityId = Objects.requireNonNull(identityId, "Missing identity id"); + this.companionIdentity = companionIdentity; + this.senderKeys = Objects.requireNonNullElseGet(senderKeys, ConcurrentHashMap::new); + this.appStateKeys = Objects.requireNonNullElseGet(appStateKeys, ArrayList::new); + this.sessions = Objects.requireNonNullElseGet(sessions, ConcurrentHashMap::new); + this.hashStates = Objects.requireNonNullElseGet(hashStates, ArrayList::new); + this.groupsPreKeys = Objects.requireNonNullElseGet(groupsPreKeys, ConcurrentHashMap::new); + this.registered = registered; + this.businessCertificate = businessCertificate; + this.initialAppSync = initialAppSync; + this.writeCounter = new AtomicLong(); + this.readCounter = new AtomicLong(); + } + + public static Keys newKeys(UUID uuid, Long phoneNumber, Collection alias, ClientType clientType) { + return new KeysBuilder() + .uuid(uuid) + .phoneNumber(PhoneNumber.ofNullable(phoneNumber).orElse(null)) + .alias(alias) + .clientType(clientType) + .noiseKeyPair(SignalKeyPair.random()) + .identityKeyPair(SignalKeyPair.random()) + .identityId(Bytes.random(16)) + .build(); + } + + /** + * Returns the encoded id + * + * @return a non-null byte array + */ + public byte[] encodedRegistrationId() { + return Bytes.intToBytes(registrationId(), 4); + } + + /** + * Clears the signal keys associated with this object + */ + public void clearReadWriteKey() { + this.writeKey = null; + this.writeCounter.set(0); + this.readCounter.set(0); + } + + /** + * Checks if the client sent pre keys to the server + * + * @return true if the client sent pre keys to the server + */ + public boolean hasPreKeys() { + return !preKeys.isEmpty(); + } + + /** + * Queries the first {@link SenderKeyRecord} that matches {@code name} + * + * @param name the non-null name to search + * @return a non-null SenderKeyRecord + */ + public SenderKeyRecord findSenderKeyByName(SenderKeyName name) { + return requireNonNullElseGet(senderKeys.get(name), () -> { + var record = new SenderKeyRecord(); + senderKeys.put(name, record); + return record; + }); + } + + /** + * Queries the {@link Session} that matches {@code address} + * + * @param address the non-null address to search + * @return a non-null Optional SessionRecord + */ + public Optional findSessionByAddress(SessionAddress address) { + return Optional.ofNullable(sessions.get(address)); + } + + /** + * Queries the trusted key that matches {@code id} + * + * @param id the id to search + * @return a non-null signed key pair + * @throws IllegalArgumentException if no element can be found + */ + public Optional findSignedKeyPairById(int id) { + return id == signedKeyPair.id() ? Optional.of(signedKeyPair) : Optional.empty(); + } + + /** + * Queries the trusted key that matches {@code id} + * + * @param id the non-null id to search + * @return a non-null pre key + */ + public Optional findPreKeyById(Integer id) { + return id == null ? Optional.empty() : preKeys.stream().filter(preKey -> preKey.id() == id).findFirst(); + } + + /** + * Queries the app state key that matches {@code id} + * + * @param jid the non-null jid of the app key + * @param id the non-null id to search + * @return a non-null Optional app state dataSync key + */ + public Optional findAppKeyById(Jid jid, byte[] id) { + return appStateKeys.stream() + .filter(preKey -> Objects.equals(preKey.companion(), jid)) + .map(CompanionSyncKey::keys) + .flatMap(Collection::stream) + .filter(preKey -> preKey.keyId() != null && Arrays.equals(preKey.keyId().keyId(), id)) + .findFirst(); + } + + /** + * Queries the hash state that matches {@code name}. Otherwise, creates a new one. + * + * @param device the non-null device + * @param patchType the non-null name to search + * @return a non-null hash state + */ + public Optional findHashStateByName(Jid device, PatchType patchType) { + return hashStates.stream() + .filter(hashState -> Objects.equals(hashState.companion(), device) && hashState.state().type() == patchType) + .findFirst() + .map(CompanionPatch::state); + } + + /** + * Checks whether {@code identityKey} is trusted for {@code address} + * + * @param address the non-null address + * @param identityKey the nullable identity key + * @return true if any match is found + */ + public boolean hasTrust(SessionAddress address, byte[] identityKey) { + return true; // At least for now + } + + /** + * Checks whether a session already whatsappOldEligible for the given address + * + * @param address the address to check + * @return true if a session for that address already whatsappOldEligible + */ + public boolean hasSession(SessionAddress address) { + return sessions.containsKey(address); + } + + /** + * Adds the provided address and record to the known sessions + * + * @param address the non-null address + * @param record the non-null record + * @return this + */ + public Keys putSession(SessionAddress address, Session record) { + sessions.put(address, record); + return this; + } + + /** + * Adds the provided hash state to the known ones + * + * @param device the non-null device + * @param state the non-null hash state + * @return this + */ + public Keys putState(Jid device, CompanionHashState state) { + var hashState = new CompanionPatch(device, state); + hashStates.add(hashState); + return this; + } + + /** + * Adds the provided keys to the app state keys + * + * @param jid the non-null jid of the app key + * @param keys the keys to add + * @return this + */ + public Keys addAppKeys(Jid jid, Collection keys) { + appStateKeys.stream() + .filter(preKey -> Objects.equals(preKey.companion(), jid)) + .findFirst() + .ifPresentOrElse(key -> key.keys().addAll(keys), () -> { + var syncKey = new CompanionSyncKey(jid, new LinkedList<>(keys)); + appStateKeys.add(syncKey); + }); + return this; + } + + /** + * Get any available app key + * + * @return a non-null app key + */ + public AppStateSyncKey getLatestAppKey(Jid jid) { + return getAppKeys(jid).getLast(); + } + + /** + * Get any available app key + * + * @return a non-null app key + */ + public LinkedList getAppKeys(Jid jid) { + return appStateKeys.stream() + .filter(preKey -> Objects.equals(preKey.companion(), jid)) + .findFirst() + .orElseThrow(() -> new NoSuchElementException("Missing keys")) + .keys(); + } + + /** + * Adds the provided pre key to the pre keys + * + * @param preKey the key to add + * @return this + */ + public Keys addPreKey(SignalPreKeyPair preKey) { + preKeys.add(preKey); + return this; + } + + /** + * Returns write counter + * + * @param increment whether the counter should be incremented after the call + * @return an unsigned long + */ + public long writeCounter(boolean increment) { + return increment ? writeCounter.getAndIncrement() : writeCounter.get(); + } + + /** + * Returns read counter + * + * @param increment whether the counter should be incremented after the call + * @return an unsigned long + */ + public long readCounter(boolean increment) { + return increment ? readCounter.getAndIncrement() : readCounter.get(); + } + + /** + * Returns the id of the last available pre key + * + * @return an integer + */ + public int lastPreKeyId() { + return preKeys.isEmpty() ? 0 : preKeys.getLast().id(); + } + + /** + * This function sets the companionIdentity field to the value of the companionIdentity parameter, + * serializes the object, and returns the object. + * + * @param companionIdentity The identity of the companion device. + * @return The object itself. + */ + public Keys companionIdentity(SignedDeviceIdentity companionIdentity) { + this.companionIdentity = companionIdentity; + return this; + } + + /** + * Returns the companion identity of this session + * Only available for web sessions + * + * @return an optional + */ + public Optional companionIdentity() { + return Optional.ofNullable(companionIdentity); + } + + /** + * Returns all the registered pre keys + * + * @return a non-null collection + */ + public Collection preKeys() { + return Collections.unmodifiableList(preKeys); + } + + public void addRecipientWithPreKeys(Jid group, Jid recipient) { + var preKeys = groupsPreKeys.get(group); + if (preKeys != null) { + preKeys.addPreKey(recipient); + return; + } + + var newPreKeys = new SenderPreKeys(); + newPreKeys.addPreKey(recipient); + groupsPreKeys.put(group, newPreKeys); + } + + public void addRecipientsWithPreKeys(Jid group, Collection recipients) { + var preKeys = groupsPreKeys.get(group); + if (preKeys != null) { + preKeys.addPreKeys(recipients); + return; + } + + var newPreKeys = new SenderPreKeys(); + newPreKeys.addPreKeys(recipients); + groupsPreKeys.put(group, newPreKeys); + } + + public boolean hasGroupKeys(Jid group, Jid recipient) { + var preKeys = groupsPreKeys.get(group); + return preKeys != null && preKeys.contains(recipient); + } + + @Override + public void dispose() { + serialize(false); + } + + @Override + public void serialize(boolean async) { + serializer.serializeKeys(this, async); + } + + public int registrationId() { + return this.registrationId; + } + + public SignalKeyPair noiseKeyPair() { + return this.noiseKeyPair; + } + + public SignalKeyPair ephemeralKeyPair() { + return this.ephemeralKeyPair; + } + + public SignalKeyPair identityKeyPair() { + return this.identityKeyPair; + } + + public SignalSignedKeyPair signedKeyPair() { + return this.signedKeyPair; + } + + public Optional signedKeyIndex() { + return Optional.ofNullable(signedKeyIndex); + } + + public OptionalLong signedKeyIndexTimestamp() { + return Clock.parseTimestamp(signedKeyIndexTimestamp); + } + + public SignalKeyPair companionKeyPair() { + return this.companionKeyPair; + } + + public String fdid() { + return this.fdid; + } + + public byte[] deviceId() { + return this.deviceId; + } + + public UUID advertisingId() { + return this.advertisingId; + } + + public byte[] identityId() { + return this.identityId; + } + + public Map senderKeys() { + return this.senderKeys; + } + + public List appStateKeys() { + return appStateKeys; + } + + public Map sessions() { + return this.sessions; + } + + public List hashStates() { + return hashStates; + } + + public Map groupsPreKeys() { + return this.groupsPreKeys; + } + + public boolean registered() { + return this.registered; + } + + public boolean businessCertificate() { + return this.businessCertificate; + } + + public boolean initialAppSync() { + return this.initialAppSync; + } + + public AtomicLong writeCounter() { + return this.writeCounter; + } + + public AtomicLong readCounter() { + return this.readCounter; + } + + public Optional writeKey() { + return Optional.ofNullable(this.writeKey); + } + + public Optional readKey() { + return Optional.ofNullable(this.readKey); + } + + public Keys setCompanionKeyPair(SignalKeyPair companionKeyPair) { + this.companionKeyPair = companionKeyPair; + return this; + } + + public Keys setSignedKeyIndex(byte[] signedKeyIndex) { + this.signedKeyIndex = signedKeyIndex; + return this; + } + + public Keys setSignedKeyIndexTimestamp(Long signedKeyIndexTimestamp) { + this.signedKeyIndexTimestamp = signedKeyIndexTimestamp; + return this; + } + + public Keys setCompanionIdentity(SignedDeviceIdentity companionIdentity) { + this.companionIdentity = companionIdentity; + return this; + } + + public Keys setRegistered(boolean registered) { + this.registered = registered; + return this; + } + + public Keys setBusinessCertificate(boolean businessCertificate) { + this.businessCertificate = businessCertificate; + return this; + } + + public Keys setInitialAppSync(boolean initialAppSync) { + this.initialAppSync = initialAppSync; + return this; + } + + public Keys setWriteKey(byte[] writeKey) { + this.writeKey = writeKey; + return this; + } + + public Keys setReadKey(byte[] readKey) { + this.readKey = readKey; + return this; + } + + /** + * Six part keys representation + * + * @return a string + */ + @Override + public String toString() { + var cryptographicKeys = Stream.of(noiseKeyPair.publicKey(), noiseKeyPair.privateKey(), identityKeyPair.publicKey(), identityKeyPair.privateKey(), identityId()) + .map(Base64.getEncoder()::encodeToString) + .collect(Collectors.joining(",")); + return phoneNumber() + .map(phoneNumber -> phoneNumber + "," + cryptographicKeys) + .orElse(cryptographicKeys); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/controller/ProtobufControllerSerializer.java b/src/main/java/it/auties/whatsapp/controller/ProtobufControllerSerializer.java new file mode 100644 index 000000000..54bd589c7 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/controller/ProtobufControllerSerializer.java @@ -0,0 +1,800 @@ +package it.auties.whatsapp.controller; + +import it.auties.whatsapp.api.ClientType; +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.chat.ChatBuilder; +import it.auties.whatsapp.model.chat.ChatSpec; +import it.auties.whatsapp.model.info.ContextInfo; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.message.model.ContextualMessage; +import it.auties.whatsapp.model.mobile.PhoneNumber; +import it.auties.whatsapp.model.newsletter.Newsletter; +import it.auties.whatsapp.model.newsletter.NewsletterSpec; +import it.auties.whatsapp.model.sync.HistorySyncMessage; + +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.*; +import java.nio.file.attribute.BasicFileAttributes; +import java.nio.file.attribute.FileTime; +import java.util.*; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ConcurrentMap; +import java.util.function.Consumer; +import java.util.function.IntFunction; +import java.util.function.Predicate; +import java.util.function.UnaryOperator; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import java.util.zip.GZIPInputStream; +import java.util.zip.GZIPOutputStream; + +class ProtobufControllerSerializer implements ControllerSerializer { + private static final Path DEFAULT_SERIALIZER_PATH = Path.of(System.getProperty("user.home") + "/.cobalt/"); + private static final String CHAT_PREFIX = "chat_"; + private static final String NEWSLETTER_PREFIX = "newsletter_"; + private static final String STORE_NAME = "store.proto"; + private static final String KEYS_NAME = "keys.proto"; + + private static final Map serializers = new ConcurrentHashMap<>(); + static { + serializers.put(DEFAULT_SERIALIZER_PATH, new ProtobufControllerSerializer(DEFAULT_SERIALIZER_PATH)); + } + + + private final Path baseDirectory; + private final ConcurrentMap> attributeStoreSerializers; + private LinkedList cachedUuids; + private LinkedList cachedPhoneNumbers; + + public static ControllerSerializer ofDefaultPath() { + return Objects.requireNonNull(serializers.get(DEFAULT_SERIALIZER_PATH)); + } + + public static ControllerSerializer of(Path baseDirectory) { + var known = serializers.get(baseDirectory); + if(known != null) { + return known; + } + + var result = new ProtobufControllerSerializer(baseDirectory); + serializers.put(baseDirectory, result); + return result; + } + + private ProtobufControllerSerializer(Path baseDirectory) { + this.baseDirectory = baseDirectory; + this.attributeStoreSerializers = new ConcurrentHashMap<>(); + } + + @Override + public LinkedList listIds(ClientType type) { + if (cachedUuids != null) { + return new ImmutableLinkedList<>(cachedUuids); + } + + var directory = getHome(type); + if (Files.notExists(directory)) { + return ImmutableLinkedList.empty(); + } + + try (var walker = Files.walk(directory, 1).sorted(Comparator.comparing(this::getLastModifiedTime))) { + return cachedUuids = walker.map(this::parsePathAsId) + .flatMap(Optional::stream) + .collect(Collectors.toCollection(LinkedList::new)); + } catch (IOException exception) { + return ImmutableLinkedList.empty(); + } + } + + @Override + public LinkedList listPhoneNumbers(ClientType type) { + if (cachedPhoneNumbers != null) { + return new ImmutableLinkedList<>(cachedPhoneNumbers); + } + + var directory = getHome(type); + if (Files.notExists(directory)) { + return ImmutableLinkedList.empty(); + } + + try (var walker = Files.walk(directory, 1).sorted(Comparator.comparing(this::getLastModifiedTime))) { + return cachedPhoneNumbers = walker.map(this::parsePathAsPhoneNumber) + .flatMap(Optional::stream) + .collect(Collectors.toCollection(LinkedList::new)); + } catch (IOException exception) { + return ImmutableLinkedList.empty(); + } + } + + private FileTime getLastModifiedTime(Path path) { + try { + return Files.getLastModifiedTime(path); + } catch (IOException exception) { + return FileTime.fromMillis(0); + } + } + + private Optional parsePathAsId(Path file) { + try { + return Optional.of(UUID.fromString(file.getFileName().toString())); + } catch (IllegalArgumentException ignored) { + return Optional.empty(); + } + } + + private Optional parsePathAsPhoneNumber(Path file) { + try { + var longValue = Long.parseLong(file.getFileName().toString()); + return PhoneNumber.ofNullable(longValue); + } catch (IllegalArgumentException ignored) { + return Optional.empty(); + } + } + + @Override + public CompletableFuture serializeKeys(Keys keys, boolean async) { + if (cachedUuids != null && !cachedUuids.contains(keys.uuid())) { + cachedUuids.add(keys.uuid()); + } + + var outputFile = getSessionFile(keys.clientType(), keys.uuid().toString(), KEYS_NAME); + if (async) { + return CompletableFuture.runAsync(() -> writeFile(KeysSpec.encode(keys), KEYS_NAME, outputFile)) + .exceptionallyAsync(this::onError); + } + + writeFile(KeysSpec.encode(keys), KEYS_NAME, outputFile); + return CompletableFuture.completedFuture(null); + } + + @Override + public CompletableFuture serializeStore(Store store, boolean async) { + if (cachedUuids != null && !cachedUuids.contains(store.uuid())) { + cachedUuids.add(store.uuid()); + } + + var phoneNumber = store.phoneNumber().orElse(null); + if (cachedPhoneNumbers != null && !cachedPhoneNumbers.contains(phoneNumber)) { + cachedPhoneNumbers.add(phoneNumber); + } + + var task = attributeStoreSerializers.get(store.uuid()); + if (task != null && !task.isDone()) { + return task; + } + + var chatsFutures = serializeChatsAsync(store); + var newslettersFutures = serializeNewslettersAsync(store); + var dependableFutures = Stream.of(chatsFutures, newslettersFutures) + .flatMap(Arrays::stream) + .toArray(CompletableFuture[]::new); + var result = CompletableFuture.allOf(dependableFutures).thenRunAsync(() -> { + var storePath = getSessionFile(store, STORE_NAME); + writeFile(StoreSpec.encode(store), STORE_NAME, storePath); + }); + if (async) { + return result; + } + + result.join(); + return CompletableFuture.completedFuture(null); + } + + private CompletableFuture[] serializeChatsAsync(Store store) { + return store.chats() + .stream() + .map(chat -> serializeChatAsync(store, chat)) + .toArray(CompletableFuture[]::new); + } + + private CompletableFuture serializeChatAsync(Store store, Chat chat) { + if (!chat.hasUpdate()) { + return CompletableFuture.completedFuture(null); + } + + var fileName = CHAT_PREFIX + chat.jid().user() + ".proto"; + var outputFile = getSessionFile(store, fileName); + return CompletableFuture.runAsync(() -> writeFile(ChatSpec.encode(chat), fileName, outputFile)) + .exceptionallyAsync(this::onError); + } + + private Void onError(Throwable error) { + var logger = System.getLogger("Serializer"); + logger.log(System.Logger.Level.ERROR, error); + return null; + } + + private CompletableFuture[] serializeNewslettersAsync(Store store) { + return store.newsletters() + .stream() + .map(newsletter -> serializeNewsletterAsync(store, newsletter)) + .toArray(CompletableFuture[]::new); + } + + private CompletableFuture serializeNewsletterAsync(Store store, Newsletter newsletter) { + var fileName = NEWSLETTER_PREFIX + newsletter.jid().user() + ".proto"; + var outputFile = getSessionFile(store, fileName); + return CompletableFuture.runAsync(() -> writeFile(NewsletterSpec.encode(newsletter), fileName, outputFile)); + } + + private void writeFile(byte[] object, String fileName, Path outputFile) { + try { + Files.createDirectories(outputFile.getParent()); + var tempFile = Files.createTempFile(fileName, ".tmp"); + try (var tempFileOutputStream = new GZIPOutputStream(Files.newOutputStream(tempFile))) { + tempFileOutputStream.write(object); + } + Files.move(tempFile, outputFile, StandardCopyOption.REPLACE_EXISTING); + } catch (IOException exception) { + throw new UncheckedIOException("Cannot write file", exception); + } + } + + @Override + public Optional deserializeKeys(ClientType type, UUID id) { + return deserializeKeysFromId(type, id.toString()); + } + + @Override + public Optional deserializeKeys(ClientType type, String alias) { + var file = getSessionDirectory(type, alias); + if (Files.notExists(file)) { + return Optional.empty(); + } + + try { + return deserializeKeysFromId(type, Files.readString(file)); + } catch (IOException exception) { + return Optional.empty(); + } + } + + @Override + public Optional deserializeKeys(ClientType type, long phoneNumber) { + var file = getSessionDirectory(type, String.valueOf(phoneNumber)); + if (Files.notExists(file)) { + return Optional.empty(); + } + + try { + return deserializeKeysFromId(type, Files.readString(file)); + } catch (IOException exception) { + return Optional.empty(); + } + } + + private Optional deserializeKeysFromId(ClientType type, String id) { + var path = getSessionFile(type, id, "keys.proto"); + try (var input = new GZIPInputStream(Files.newInputStream(path))) { + return Optional.of(KeysSpec.decode(input.readAllBytes())); + } catch (IOException exception) { + return Optional.empty(); + } + } + + @Override + public Optional deserializeStore(ClientType type, UUID id) { + return deserializeStoreFromId(type, id.toString()); + } + + @Override + public Optional deserializeStore(ClientType type, String alias) { + var file = getSessionDirectory(type, alias); + if (Files.notExists(file)) { + return Optional.empty(); + } + + try { + return deserializeStoreFromId(type, Files.readString(file)); + } catch (IOException exception) { + return Optional.empty(); + } + } + + @Override + public Optional deserializeStore(ClientType type, long phoneNumber) { + var file = getSessionDirectory(type, String.valueOf(phoneNumber)); + if (Files.notExists(file)) { + return Optional.empty(); + } + + try { + return deserializeStoreFromId(type, Files.readString(file)); + } catch (IOException exception) { + return Optional.empty(); + } + } + + private Optional deserializeStoreFromId(ClientType type, String id) { + var path = getSessionFile(type, id, "store.proto"); + if (Files.notExists(path)) { + return Optional.empty(); + } + + try (var input = new GZIPInputStream(Files.newInputStream(path))) { + return Optional.of(StoreSpec.decode(input.readAllBytes())); + } catch (IOException exception) { + return Optional.empty(); + } + } + + @Override + public CompletableFuture attributeStore(Store store) { + var oldTask = attributeStoreSerializers.get(store.uuid()); + if (oldTask != null) { + return oldTask; + } + var directory = getSessionDirectory(store.clientType(), store.uuid().toString()); + if (Files.notExists(directory)) { + return CompletableFuture.completedFuture(null); + } + try (var walker = Files.walk(directory)) { + var futures = walker.map(entry -> handleStoreFile(store, entry)) + .filter(Objects::nonNull) + .toArray(CompletableFuture[]::new); + var result = CompletableFuture.allOf(futures) + .thenRun(() -> attributeStoreContextualMessages(store)); + attributeStoreSerializers.put(store.uuid(), result); + return result; + } catch (IOException exception) { + return CompletableFuture.failedFuture(exception); + } + } + + // Do this after we have all the chats, or it won't work for obvious reasons + private void attributeStoreContextualMessages(Store store) { + store.chats() + .stream() + .flatMap(chat -> chat.messages().stream()) + .forEach(message -> attributeStoreContextualMessage(store, message)); + } + + private void attributeStoreContextualMessage(Store store, HistorySyncMessage message) { + message.messageInfo() + .message() + .contentWithContext() + .flatMap(ContextualMessage::contextInfo) + .ifPresent(contextInfo -> attributeStoreContextInfo(store, contextInfo)); + } + + private void attributeStoreContextInfo(Store store, ContextInfo contextInfo) { + contextInfo.quotedMessageChatJid() + .flatMap(store::findChatByJid) + .ifPresent(contextInfo::setQuotedMessageChat); + } + + private CompletableFuture handleStoreFile(Store store, Path entry) { + return switch (FileType.of(entry)) { + case NEWSLETTER -> CompletableFuture.runAsync(() -> deserializeNewsletter(store, entry)) + .exceptionallyAsync(this::onError); + case CHAT -> CompletableFuture.runAsync(() -> deserializeChat(store, entry)) + .exceptionallyAsync(this::onError); + case UNKNOWN -> null; + }; + } + + private enum FileType { + UNKNOWN(null), + CHAT(CHAT_PREFIX), + NEWSLETTER(NEWSLETTER_PREFIX); + + private final String prefix; + + FileType(String prefix) { + this.prefix = prefix; + } + + private static FileType of(Path path) { + return Arrays.stream(values()) + .filter(entry -> entry.prefix() != null && path.getFileName().toString().startsWith(entry.prefix())) + .findFirst() + .orElse(UNKNOWN); + } + + private String prefix() { + return prefix; + } + } + + @Override + public void deleteSession(Controller controller) { + try { + var folderPath = getSessionDirectory(controller.clientType(), controller.uuid().toString()); + delete(folderPath); + var phoneNumber = controller.phoneNumber().orElse(null); + if (phoneNumber == null) { + return; + } + var linkedFolderPath = getSessionDirectory(controller.clientType(), phoneNumber.toString()); + Files.deleteIfExists(linkedFolderPath); + } catch (IOException exception) { + throw new UncheckedIOException("Cannot delete session", exception); + } + } + + private void delete(Path path) throws IOException { + Files.walkFileTree(path, new SimpleFileVisitor<>() { + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + Files.delete(file); + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException { + Files.delete(dir); + return FileVisitResult.CONTINUE; + } + }); + } + + @Override + public void linkMetadata(Controller controller) { + controller.phoneNumber() + .ifPresent(phoneNumber -> linkToUuid(controller.clientType(), controller.uuid(), phoneNumber.toString())); + controller.alias() + .forEach(alias -> linkToUuid(controller.clientType(), controller.uuid(), alias)); + } + + private void linkToUuid(ClientType type, UUID uuid, String string) { + try { + var link = getSessionDirectory(type, string); + Files.writeString(link, uuid.toString(), StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING); + } catch (IOException ignored) { + + } + } + + private void deserializeChat(Store store, Path chatFile) { + try (var input = new GZIPInputStream(Files.newInputStream(chatFile))) { + var chat = ChatSpec.decode(input.readAllBytes()); + for (var message : chat.messages()) { + message.messageInfo().setChat(chat); + } + store.addChatDirect(chat); + } catch (IOException exception) { + store.addChatDirect(rescueChat(chatFile)); + } + } + + private Chat rescueChat(Path entry) { + try { + Files.deleteIfExists(entry); + } catch (IOException ignored) { + + } + var chatName = entry.getFileName().toString() + .replaceFirst(CHAT_PREFIX, "") + .replace(".proto", ""); + return new ChatBuilder() + .jid(Jid.of(chatName)) + .build(); + } + + private void deserializeNewsletter(Store store, Path newsletterFile) { + try (var input = new GZIPInputStream(Files.newInputStream(newsletterFile))) { + var newsletter = NewsletterSpec.decode(input.readAllBytes()); + for (var message : newsletter.messages()) { + message.setNewsletter(newsletter); + } + store.addNewsletter(newsletter); + } catch (IOException exception) { + store.addNewsletter(rescueNewsletter(newsletterFile)); + } + } + + private Newsletter rescueNewsletter(Path entry) { + try { + Files.deleteIfExists(entry); + } catch (IOException ignored) { + + } + var newsletterName = entry.getFileName().toString() + .replaceFirst(CHAT_PREFIX, "") + .replace(".proto", ""); + return new Newsletter(Jid.of(newsletterName), null, null, null); + } + + private Path getHome(ClientType type) { + return baseDirectory.resolve(type == ClientType.MOBILE ? "mobile" : "web"); + } + + private Path getSessionDirectory(ClientType clientType, String path) { + try { + var result = getHome(clientType).resolve(path); + Files.createDirectories(result.getParent()); + return result; + } catch (IOException exception) { + throw new UncheckedIOException(exception); + } + } + + private Path getSessionFile(Store store, String fileName) { + try { + var result = getSessionFile(store.clientType(), store.uuid().toString(), fileName); + Files.createDirectories(result.getParent()); + return result; + } catch (IOException exception) { + throw new UncheckedIOException("Cannot create directory", exception); + } + } + + private Path getSessionFile(ClientType clientType, String uuid, String fileName) { + try { + var result = getSessionDirectory(clientType, uuid).resolve(fileName); + Files.createDirectories(result.getParent()); + return result; + } catch (IOException exception) { + throw new UncheckedIOException("Cannot create directory", exception); + } + } + + private static class ImmutableLinkedList extends LinkedList { + @SuppressWarnings({"rawtypes", "unchecked"}) + private static final ImmutableLinkedList EMPTY = new ImmutableLinkedList(new LinkedList()); + + private final LinkedList delegate; + + @SuppressWarnings("unchecked") + private static ImmutableLinkedList empty() { + return EMPTY; + } + + private ImmutableLinkedList(LinkedList delegate) { + this.delegate = delegate; + } + + @Override + public E getFirst() { + return delegate.getFirst(); + } + + @Override + public E getLast() { + return delegate.getLast(); + } + + @Override + public boolean contains(Object o) { + return delegate.contains(o); + } + + @Override + public int size() { + return delegate.size(); + } + + @Override + public void clear() { + throw new UnsupportedOperationException(); + } + + @Override + public E get(int index) { + return delegate.get(index); + } + + @Override + public int indexOf(Object o) { + return delegate.indexOf(o); + } + + @Override + public int lastIndexOf(Object o) { + return delegate.lastIndexOf(o); + } + + @Override + public E peek() { + return delegate.peek(); + } + + @Override + public E element() { + return delegate.element(); + } + + @Override + public E poll() { + return delegate.poll(); + } + + @Override + public boolean offer(E e) { + return delegate.offer(e); + } + + @Override + public boolean offerFirst(E e) { + return delegate.offerFirst(e); + } + + @Override + public boolean offerLast(E e) { + return delegate.offerLast(e); + } + + @Override + public E peekFirst() { + return delegate.peekFirst(); + } + + @Override + public E peekLast() { + return delegate.peekLast(); + } + + @Override + public E pollFirst() { + throw new UnsupportedOperationException(); + } + + @Override + public E pollLast() { + throw new UnsupportedOperationException(); + } + + @Override + public void push(E e) { + delegate.push(e); + } + + @Override + public E pop() { + throw new UnsupportedOperationException(); + } + + @Override + public ListIterator listIterator(int index) { + return delegate.listIterator(index); + } + + @Override + public Iterator descendingIterator() { + return delegate.descendingIterator(); + } + + @SuppressWarnings("MethodDoesntCallSuperMethod") + @Override + public Object clone() { + return delegate.clone(); + } + + @Override + public Object[] toArray() { + return delegate.toArray(); + } + + @Override + public T[] toArray(T[] a) { + return delegate.toArray(a); + } + + @Override + public Spliterator spliterator() { + return delegate.spliterator(); + } + + @Override + public LinkedList reversed() { + return delegate.reversed(); + } + + @Override + public void replaceAll(UnaryOperator operator) { + throw new UnsupportedOperationException(); + } + + @Override + public void sort(Comparator c) { + delegate.sort(c); + } + + @Override + public T[] toArray(IntFunction generator) { + return delegate.toArray(generator); + } + + @Override + public Stream stream() { + return delegate.stream(); + } + + @Override + public Stream parallelStream() { + return delegate.parallelStream(); + } + + @Override + public void forEach(Consumer action) { + delegate.forEach(action); + } + + @Override + public boolean add(E e) { + throw new UnsupportedOperationException(); + } + + @Override + public void add(int index, E element) { + throw new UnsupportedOperationException(); + } + + @Override + public void addLast(E e) { + throw new UnsupportedOperationException(); + } + + @Override + public void addFirst(E e) { + throw new UnsupportedOperationException(); + } + + @Override + public boolean addAll(Collection c) { + throw new UnsupportedOperationException(); + } + + @Override + public boolean addAll(int index, Collection c) { + throw new UnsupportedOperationException(); + } + + @Override + public boolean remove(Object o) { + throw new UnsupportedOperationException(); + } + + @Override + public E remove() { + throw new UnsupportedOperationException(); + } + + @Override + public E removeFirst() { + throw new UnsupportedOperationException(); + } + + @Override + public E removeLast() { + throw new UnsupportedOperationException(); + } + + @Override + protected void removeRange(int fromIndex, int toIndex) { + throw new UnsupportedOperationException(); + } + + @Override + public boolean removeAll(Collection c) { + throw new UnsupportedOperationException(); + } + + @Override + public boolean removeFirstOccurrence(Object o) { + throw new UnsupportedOperationException(); + } + + @Override + public E remove(int index) { + throw new UnsupportedOperationException(); + } + + @Override + public boolean removeIf(Predicate filter) { + throw new UnsupportedOperationException(); + } + + @Override + public boolean removeLastOccurrence(Object o) { + throw new UnsupportedOperationException(); + } + + @Override + public E set(int index, E element) { + throw new UnsupportedOperationException(); + } + } +} diff --git a/src/main/java/it/auties/whatsapp/controller/Store.java b/src/main/java/it/auties/whatsapp/controller/Store.java new file mode 100644 index 000000000..84951b7fa --- /dev/null +++ b/src/main/java/it/auties/whatsapp/controller/Store.java @@ -0,0 +1,1562 @@ +package it.auties.whatsapp.controller; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonGetter; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonValue; +import it.auties.protobuf.annotation.ProtobufConverter; +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.WhatsappMetadata; +import it.auties.whatsapp.socket.SocketRequest; +import it.auties.whatsapp.util.*; + +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.function.Supplier; +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, mixin = ProtobufFutureMixin.class) + CompletableFuture 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 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 = 40, type = ProtobufType.STRING) + String verifiedName; + + /** + * 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 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; + + @ProtobufProperty(index = 41, type = ProtobufType.BOOL) + boolean automaticMessageReceipts; + + /** + * 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, CompletableFuture version, boolean online, CountryLocale locale, String name, String verifiedName, 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 automaticPresenceUpdates, boolean automaticMessageReceipts, ReleaseChannel releaseChannel, CompanionDevice device, boolean checkPatchMacs) { + super(uuid, phoneNumber, null, clientType, alias); + if (proxy != null) { + ProxyAuthenticator.globalAuthenticator().register(proxy); + } + + this.proxy = proxy; + this.version = version; + this.online = online; + this.locale = locale; + this.name = Objects.requireNonNullElse(name, Specification.Whatsapp.DEFAULT_NAME); + this.verifiedName = verifiedName; + 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 = Objects.requireNonNullElseGet(linkedDevicesKeys, LinkedHashMap::new); + this.profilePicture = profilePicture; + this.about = about; + this.jid = jid; + this.lid = lid; + this.properties = Objects.requireNonNullElseGet(properties, ConcurrentHashMap::new); + this.chats = new ConcurrentHashMap<>(); + this.contacts = Objects.requireNonNullElseGet(contacts, ConcurrentHashMap::new); + this.status = Objects.requireNonNullElseGet(status, ConcurrentHashMap::newKeySet); + this.newsletters = new ConcurrentHashMap<>(); + this.privacySettings = Objects.requireNonNullElseGet(privacySettings, ConcurrentHashMap::new); + this.calls = Objects.requireNonNullElseGet(calls, ConcurrentHashMap::new); + this.unarchiveChats = unarchiveChats; + this.twentyFourHourFormat = twentyFourHourFormat; + this.requests = new ConcurrentHashMap<>(); + this.replyHandlers = new ConcurrentHashMap<>(); + this.listeners = ConcurrentHashMap.newKeySet(); + this.tag = HexFormat.of().formatHex(Bytes.random(1)); + this.initializationTimeStamp = Objects.requireNonNullElseGet(initializationTimeStamp, Clock::nowSeconds); + this.mediaConnectionLatch = new CountDownLatch(1); + this.newChatsEphemeralTimer = Objects.requireNonNullElse(newChatsEphemeralTimer, ChatEphemeralTimer.OFF); + this.textPreviewSetting = Objects.requireNonNullElse(textPreviewSetting, TextPreviewSetting.ENABLED_WITH_INFERENCE); + this.historyLength = Objects.requireNonNullElseGet(historyLength, WebHistoryLength::standard); + this.autodetectListeners = autodetectListeners; + this.automaticPresenceUpdates = automaticPresenceUpdates; + this.automaticMessageReceipts = automaticMessageReceipts; + this.releaseChannel = Objects.requireNonNullElse(releaseChannel, ReleaseChannel.RELEASE); + this.device = device; + this.checkPatchMacs = checkPatchMacs; + } + + public static Store newStore(UUID uuid, Long phoneNumber, Collection alias, ClientType clientType) { + return new StoreBuilder() + .uuid(uuid) + .initializationTimeStamp(Clock.nowSeconds()) + .phoneNumber(phoneNumber != null ? PhoneNumber.of(phoneNumber) : null) + .device(clientType == ClientType.MOBILE ? CompanionDevice.ios(false) : CompanionDevice.web()) + .clientType(clientType) + .alias(alias) + .name(Specification.Whatsapp.DEFAULT_NAME) + .jid(phoneNumber != null ? Jid.of(phoneNumber) : null) + .autodetectListeners(true) + .automaticPresenceUpdates(true) + .automaticMessageReceipts(clientType == ClientType.MOBILE) + .build(); + } + + /** + * 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) { + return switch (jid) { + case Contact contact -> Optional.of(contact); + case null -> Optional.empty(); + default -> 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; + } + + public boolean hasMediaConnection() { + return mediaConnection != null; + } + + /** + * 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 removeListeners() { + 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.globalAuthenticator().register(proxy); + } else if (proxy == null && this.proxy != null) { + ProxyAuthenticator.globalAuthenticator().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)); + } + + /** + * Returns all the calls registered + * + * @return an unmodifiable collection + */ + public Collection calls() { + return Collections.unmodifiableCollection(calls.values()); + } + + public String tag() { + return tag; + } + + @JsonGetter("version") + public Version version() { + if(version == null) { + this.version = WhatsappMetadata.getVersion(device.platform()); + } + + return version.join(); + } + + 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 automaticPresenceUpdates() { + return this.automaticPresenceUpdates; + } + + public ReleaseChannel releaseChannel() { + return this.releaseChannel; + } + + public CompanionDevice device() { + return device; + } + + public boolean checkPatchMacs() { + return this.checkPatchMacs; + } + + public boolean automaticMessageReceipts() { + return automaticPresenceUpdates; + } + + 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 Store setAutomaticPresenceUpdates(boolean automaticPresenceUpdates) { + this.automaticPresenceUpdates = automaticPresenceUpdates; + return this; + } + + public Store setReleaseChannel(ReleaseChannel releaseChannel) { + this.releaseChannel = releaseChannel; + return this; + } + + public Store setDevice(CompanionDevice device) { + if(Objects.equals(device(), device)) { + return this; + } + + Objects.requireNonNull(device, "The device cannot be null"); + this.device = device; + this.version = device.appVersion() + .map(CompletableFuture::completedFuture) + .orElseGet(() -> WhatsappMetadata.getVersion(device.platform())); + return this; + } + + public Store setCheckPatchMacs(boolean checkPatchMacs) { + this.checkPatchMacs = checkPatchMacs; + return this; + } + + public Optional verifiedName() { + return Optional.ofNullable(verifiedName); + } + + public Store setVerifiedName(String verifiedName) { + this.verifiedName = verifiedName; + return this; + } + + public Store setAutomaticMessageReceipts(boolean automaticMessageReceipts) { + this.automaticMessageReceipts = automaticMessageReceipts; + return this; + } + + private static class AsyncVersion { + private Version value; + private CompletableFuture future; + + @JsonCreator + private AsyncVersion(Version initialValue) { + this.value = Objects.requireNonNull(initialValue, "Missing value"); + } + + public AsyncVersion(Version initialValue, Supplier> defaultValue) { + this.value = initialValue; + if (initialValue == null) { + this.future = defaultValue.get(); + } + } + + @ProtobufConverter + @JsonValue + public Version value() { + if (future != null) { + this.value = future.join(); + future = null; + } + + return value; + } + + public void setValue(Version value) { + if (future != null && !future.isDone()) { + future.cancel(true); + } + + this.future = null; + this.value = value; + } + } +} diff --git a/src/main/java/it/auties/whatsapp/controller/StoreKeysPair.java b/src/main/java/it/auties/whatsapp/controller/StoreKeysPair.java new file mode 100644 index 000000000..45f1bac6b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/controller/StoreKeysPair.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.controller; + +import it.auties.whatsapp.util.Validate; + +import java.util.Objects; + +/** + * A pair of Store and Keys with the same uuid + */ +public record StoreKeysPair(Store store, Keys keys) { + public StoreKeysPair { + Validate.isTrue(Objects.equals(store.uuid(), keys.uuid()), "UUID mismatch between store and keys"); + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/AesCbc.java b/src/main/java/it/auties/whatsapp/crypto/AesCbc.java new file mode 100644 index 000000000..ab29f1aa8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/AesCbc.java @@ -0,0 +1,52 @@ +package it.auties.whatsapp.crypto; + +import it.auties.whatsapp.util.Bytes; +import it.auties.whatsapp.util.Validate; + +import javax.crypto.Cipher; +import javax.crypto.spec.IvParameterSpec; +import javax.crypto.spec.SecretKeySpec; +import java.security.GeneralSecurityException; +import java.util.Arrays; + +public final class AesCbc { + private static final String AES_CBC = "AES/CBC/PKCS5Padding"; + private static final String AES = "AES"; + private static final int AES_BLOCK_SIZE = 16; + + public static byte[] encryptAndPrefix(byte[] plaintext, byte[] key) { + var iv = Bytes.random(AES_BLOCK_SIZE); + var encrypted = encrypt(iv, plaintext, key); + return Bytes.concat(iv, encrypted); + } + + public static byte[] encrypt(byte[] iv, byte[] plaintext, byte[] key) { + try { + var cipher = Cipher.getInstance(AES_CBC); + var keySpec = new SecretKeySpec(key, AES); + cipher.init(Cipher.ENCRYPT_MODE, keySpec, new IvParameterSpec(iv)); + return cipher.doFinal(plaintext); + } catch (GeneralSecurityException exception) { + throw new IllegalArgumentException("Cannot encrypt data", exception); + } + } + + public static byte[] decrypt(byte[] encrypted, byte[] key) { + var iv = Arrays.copyOfRange(encrypted, 0, 16); + var encryptedNoIv = Arrays.copyOfRange(encrypted, iv.length, encrypted.length); + return decrypt(iv, encryptedNoIv, key); + } + + public static byte[] decrypt(byte[] iv, byte[] encrypted, byte[] key) { + try { + Validate.isTrue(iv.length == AES_BLOCK_SIZE, "Invalid iv size: expected %s, got %s", AES_BLOCK_SIZE, iv.length); + Validate.isTrue(encrypted.length % AES_BLOCK_SIZE == 0, "Invalid encrypted size"); + var cipher = Cipher.getInstance(AES_CBC); + var keySpec = new SecretKeySpec(key, AES); + cipher.init(Cipher.DECRYPT_MODE, keySpec, new IvParameterSpec(iv)); + return cipher.doFinal(encrypted); + } catch (GeneralSecurityException exception) { + throw new IllegalArgumentException("Cannot encrypt data", exception); + } + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/AesGcm.java b/src/main/java/it/auties/whatsapp/crypto/AesGcm.java new file mode 100644 index 000000000..d7b3d7e78 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/AesGcm.java @@ -0,0 +1,71 @@ +package it.auties.whatsapp.crypto; + +import javax.crypto.Cipher; +import javax.crypto.spec.GCMParameterSpec; +import javax.crypto.spec.SecretKeySpec; +import java.io.ByteArrayOutputStream; +import java.io.DataOutputStream; +import java.io.IOException; +import java.io.UncheckedIOException; + +public final class AesGcm { + private static final int TAG_LENGTH = 128; + + private static byte[] cipher(byte[] iv, byte[] input, byte[] key, byte[] additionalData, boolean encrypt) { + try { + var cipher = Cipher.getInstance("AES/GCM/NoPadding"); + var keySpec = new SecretKeySpec(key, "AES"); + var gcmSpec = new GCMParameterSpec(TAG_LENGTH, iv); + cipher.init(encrypt ? Cipher.ENCRYPT_MODE : Cipher.DECRYPT_MODE, keySpec, gcmSpec); + if(additionalData != null) { + cipher.updateAAD(additionalData); + } + var outputLength = cipher.getOutputSize(input.length); + var output = new byte[outputLength]; + var outputOffset = cipher.update(input, 0, input.length, output, 0); + cipher.doFinal(output, outputOffset); + return output; + } catch (Throwable throwable) { + throw new RuntimeException("Cannot %s data".formatted(encrypt ? "encrypt" : "decrypt"), throwable); + } + } + + + private static byte[] toIv(long iv) { + var byteArrayOutputStream = new ByteArrayOutputStream(); + try(var dataOutputStream = new DataOutputStream(byteArrayOutputStream)) { + dataOutputStream.write(new byte[4]); + dataOutputStream.writeLong(iv); + return byteArrayOutputStream.toByteArray(); + }catch (IOException exception) { + throw new UncheckedIOException(exception); + } + } + + public static byte[] encrypt(long iv, byte[] input, byte[] key) { + return encrypt(iv, input, key, null); + } + + public static byte[] encrypt(long iv, byte[] input, byte[] key, byte[] additionalData) { + return cipher(toIv(iv), input, key, additionalData, true); + } + + public static byte[] encrypt(byte[] iv, byte[] input, byte[] key, byte[] additionalData) { + return cipher(iv, input, key, additionalData, true); + } + + public static byte[] encrypt(byte[] iv, byte[] input, byte[] key) { + return cipher(iv, input, key, null, true); + } + + public static byte[] decrypt(long iv, byte[] input, byte[] key) { + return decrypt(iv, input, key, null); + } + + public static byte[] decrypt(long iv, byte[] input, byte[] key, byte[] additionalData) { + return cipher(toIv(iv), input, key, additionalData, false); + } + public static byte[] decrypt(byte[] iv, byte[] input, byte[] key, byte[] additionalData) { + return cipher(iv, input, key, additionalData, false); + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/CipheredMessageResult.java b/src/main/java/it/auties/whatsapp/crypto/CipheredMessageResult.java new file mode 100644 index 000000000..5e00332e3 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/CipheredMessageResult.java @@ -0,0 +1,5 @@ +package it.auties.whatsapp.crypto; + +public record CipheredMessageResult(byte[] message, String type) { + +} diff --git a/src/main/java/it/auties/whatsapp/crypto/DerOutputStream.java b/src/main/java/it/auties/whatsapp/crypto/DerOutputStream.java new file mode 100644 index 000000000..48434c159 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/DerOutputStream.java @@ -0,0 +1,100 @@ +// Mirrored minimal version of sun.security.util.DerOutputStream + +/* + * Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +package it.auties.whatsapp.crypto; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.math.BigInteger; + + +/** + * Output stream marshaling DER-encoded data. This is eventually provided + * in the form of a byte array; there is no advance limit on the size of + * that byte array. + * + *

At this time, this class supports only a subset of the types of + * DER data encodings which are defined. That subset is sufficient for + * generating most X.509 certificates. + * + * @author David Brownell + * @author Amit Kapoor + * @author Hemma Prafullchandra + */ +public class DerOutputStream extends ByteArrayOutputStream { + private static final byte tag_Integer = 0x02; + private static final byte tag_BitString = 0x03; + private static final byte tag_Sequence = 0x30; + + public void writeSequence(byte[] buf) { + write(tag_Sequence); + putLength(buf.length); + write(buf, 0, buf.length); + } + + + public void putInteger(BigInteger i) { + write(tag_Integer); + byte[] buf = i.toByteArray(); // least number of bytes + putLength(buf.length); + write(buf, 0, buf.length); + } + + public void putBitString(byte[] bits) throws IOException { + write(tag_BitString); + putLength(bits.length + 1); + write(0); // all of last octet is used + write(bits); + } + + private void putLength(int len) { + if (len < 128) { + write((byte) len); + + } else if (len < (1 << 8)) { + write((byte) 0x081); + write((byte) len); + + } else if (len < (1 << 16)) { + write((byte) 0x082); + write((byte) (len >> 8)); + write((byte) len); + + } else if (len < (1 << 24)) { + write((byte) 0x083); + write((byte) (len >> 16)); + write((byte) (len >> 8)); + write((byte) len); + + } else { + write((byte) 0x084); + write((byte) (len >> 24)); + write((byte) (len >> 16)); + write((byte) (len >> 8)); + write((byte) len); + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/crypto/GroupBuilder.java b/src/main/java/it/auties/whatsapp/crypto/GroupBuilder.java new file mode 100644 index 000000000..eb2c7156e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/GroupBuilder.java @@ -0,0 +1,26 @@ +package it.auties.whatsapp.crypto; + +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.model.signal.keypair.SignalKeyPair; +import it.auties.whatsapp.model.signal.message.SignalDistributionMessage; +import it.auties.whatsapp.model.signal.sender.SenderKeyName; +import it.auties.whatsapp.util.Bytes; + +import java.util.concurrent.ThreadLocalRandom; + +public record GroupBuilder(Keys keys) { + public byte[] createOutgoing(SenderKeyName name) { + var record = keys.findSenderKeyByName(name); + if (record.isEmpty()) { + record.addState(ThreadLocalRandom.current().nextInt(), SignalKeyPair.random(), 0, Bytes.random(32)); + } + var state = record.firstState(); + var message = new SignalDistributionMessage(state.id(), state.chainKey().iteration(), state.chainKey().seed(), state.signingKey().signalPublicKey()); + return message.serialized(); + } + + public void createIncoming(SenderKeyName name, SignalDistributionMessage message) { + var record = keys.findSenderKeyByName(name); + record.addState(message.id(), message.signingKey(), message.iteration(), message.chainKey()); + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/GroupCipher.java b/src/main/java/it/auties/whatsapp/crypto/GroupCipher.java new file mode 100644 index 000000000..3f09bd0c8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/GroupCipher.java @@ -0,0 +1,55 @@ +package it.auties.whatsapp.crypto; + +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.model.signal.message.SenderKeyMessage; +import it.auties.whatsapp.model.signal.sender.SenderKeyName; +import it.auties.whatsapp.model.signal.sender.SenderKeyState; +import it.auties.whatsapp.model.signal.sender.SenderMessageKey; +import it.auties.whatsapp.util.Specification.Signal; + +import java.util.NoSuchElementException; + +public record GroupCipher(SenderKeyName name, Keys keys) { + public CipheredMessageResult encrypt(byte[] data) { + if (data == null) { + return new CipheredMessageResult(null, Signal.UNAVAILABLE); + } + + var currentState = keys.findSenderKeyByName(name).firstState(); + var messageKey = currentState.chainKey().toMessageKey(); + var ciphertext = AesCbc.encrypt(messageKey.iv(), data, messageKey.cipherKey()); + var senderKeyMessage = new SenderKeyMessage(currentState.id(), messageKey.iteration(), ciphertext, currentState.signingKey().privateKey()); + var next = currentState.chainKey().next(); + currentState.setChainKey(next); + return new CipheredMessageResult(senderKeyMessage.serialized(), Signal.SKMSG); + } + + public byte[] decrypt(byte[] data) { + var record = keys.findSenderKeyByName(name); + var senderKeyMessage = SenderKeyMessage.ofSerialized(data); + var senderKeyStates = record.findStatesById(senderKeyMessage.id()); + for (var senderKeyState : senderKeyStates) { + try { + var senderKey = getSenderKey(senderKeyState, senderKeyMessage.iteration()); + return AesCbc.decrypt(senderKey.iv(), senderKeyMessage.cipherText(), senderKey.cipherKey()); + } catch (Throwable ignored) { + } + } + throw new RuntimeException("Cannot decode message with any session"); + } + + private SenderMessageKey getSenderKey(SenderKeyState senderKeyState, int iteration) { + if (senderKeyState.chainKey().iteration() > iteration) { + return senderKeyState.findSenderMessageKey(iteration) + .orElseThrow(() -> new NoSuchElementException("Received message with old counter: got %s, expected more than %s".formatted(iteration, senderKeyState.chainKey() + .iteration()))); + } + var lastChainKey = senderKeyState.chainKey(); + while (lastChainKey.iteration() < iteration) { + senderKeyState.addSenderMessageKey(lastChainKey.toMessageKey()); + lastChainKey = lastChainKey.next(); + } + senderKeyState.setChainKey(lastChainKey.next()); + return lastChainKey.toMessageKey(); + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/Hkdf.java b/src/main/java/it/auties/whatsapp/crypto/Hkdf.java new file mode 100644 index 000000000..abbed2a4b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/Hkdf.java @@ -0,0 +1,86 @@ +package it.auties.whatsapp.crypto; + +import it.auties.whatsapp.util.Bytes; +import it.auties.whatsapp.util.Validate; + +import javax.crypto.Mac; +import javax.crypto.spec.SecretKeySpec; +import java.io.ByteArrayOutputStream; +import java.security.GeneralSecurityException; +import java.util.Arrays; + +import static it.auties.whatsapp.util.Specification.Signal.KEY_LENGTH; + +public final class Hkdf { + private static final int ITERATION_START_OFFSET = 1; // v3 + private static final int HASH_OUTPUT_SIZE = 32; + private static final byte[] DEFAULT_SALT = new byte[HASH_OUTPUT_SIZE]; + private static final String HMAC_SHA_256 = "HmacSHA256"; + + public static byte[][] deriveSecrets(byte[] input, byte[] info) { + return deriveSecrets(input, info, 3); + } + + public static byte[][] deriveSecrets(byte[] input, byte[] info, int chunks) { + return deriveSecrets(input, DEFAULT_SALT, info, chunks); + } + + public static byte[][] deriveSecrets(byte[] input, byte[] salt, byte[] info, int chunks) { + Validate.isTrue(salt.length == KEY_LENGTH, "Incorrect salt codeLength: %s", salt.length); + Validate.isTrue(chunks >= 1 && chunks <= 3, "Incorrect number of chunks: %s", chunks); + var prk = Hmac.calculateSha256(input, salt); + var result = Bytes.concat(new byte[KEY_LENGTH], info, new byte[]{1}); + var signed = new byte[chunks][]; + var key = Arrays.copyOfRange(result, KEY_LENGTH, result.length); + var first = Hmac.calculateSha256(key, prk); + signed[0] = first; + if (chunks > 1) { + System.arraycopy(first, 0, result, 0, first.length); + result[result.length - 1] = 2; + signed[1] = Hmac.calculateSha256(result, prk); + } + if (chunks > 2) { + System.arraycopy(signed[1], 0, result, 0, signed[1].length); + result[result.length - 1] = 3; + signed[2] = Hmac.calculateSha256(result, prk); + } + return signed; + } + + public static byte[][] deriveSecrets(byte[] input, byte[] salt, byte[] info) { + return deriveSecrets(input, salt, info, 3); + } + + public static byte[] extractAndExpand(byte[] key, byte[] info, int outputLength) { + return extractAndExpand(key, DEFAULT_SALT, info, outputLength); + } + + public static byte[] extractAndExpand(byte[] key, byte[] salt, byte[] info, int outputLength) { + return expand(Hmac.calculateSha256(key, salt), info, outputLength); + } + + private static byte[] expand(byte[] prk, byte[] info, int outputSize) { + try { + var iterations = (int) Math.ceil((double) outputSize / (double) HASH_OUTPUT_SIZE); + var mixin = new byte[0]; + var results = new ByteArrayOutputStream(); + for (var index = ITERATION_START_OFFSET; index < iterations + ITERATION_START_OFFSET; index++) { + var mac = Mac.getInstance(HMAC_SHA_256); + mac.init(new SecretKeySpec(prk, HMAC_SHA_256)); + mac.update(mixin); + if (info != null) { + mac.update(info); + } + mac.update((byte) index); + var stepResult = mac.doFinal(); + var stepSize = Math.min(outputSize, stepResult.length); + results.write(stepResult, 0, stepSize); + mixin = stepResult; + outputSize -= stepSize; + } + return results.toByteArray(); + } catch (GeneralSecurityException exception) { + throw new IllegalArgumentException("Cannot expand data", exception); + } + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/Hmac.java b/src/main/java/it/auties/whatsapp/crypto/Hmac.java new file mode 100644 index 000000000..da932360f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/Hmac.java @@ -0,0 +1,29 @@ +package it.auties.whatsapp.crypto; + + +import javax.crypto.Mac; +import javax.crypto.spec.SecretKeySpec; +import java.security.GeneralSecurityException; + +public final class Hmac { + private static final String HMAC_SHA_256 = "HmacSHA256"; + private static final String HMAC_SHA_512 = "HmacSHA512"; + + public static byte[] calculateSha256(byte[] plain, byte[] key) { + return calculate(HMAC_SHA_256, plain, key); + } + + public static byte[] calculateSha512(byte[] plain, byte[] key) { + return calculate(HMAC_SHA_512, plain, key); + } + + private static byte[] calculate(String algorithm, byte[] plain, byte[] key) { + try { + var localMac = Mac.getInstance(algorithm); + localMac.init(new SecretKeySpec(key, algorithm)); + return localMac.doFinal(plain); + } catch (GeneralSecurityException exception) { + throw new IllegalArgumentException("Cannot calculate hmac", exception); + } + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/LTHash.java b/src/main/java/it/auties/whatsapp/crypto/LTHash.java new file mode 100644 index 000000000..3abfc50e0 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/LTHash.java @@ -0,0 +1,78 @@ +package it.auties.whatsapp.crypto; + +import it.auties.whatsapp.model.companion.CompanionHashState; +import it.auties.whatsapp.model.sync.RecordSync; + +import java.nio.ByteBuffer; +import java.nio.ByteOrder; +import java.nio.charset.StandardCharsets; +import java.util.*; + +public class LTHash { + private static final int EXPAND_SIZE = 128; + public static final String SALT = "WhatsApp Patch Integrity"; + + private final byte[] salt; + + private final byte[] hash; + + private final Map indexValueMap; + + private final List add, subtract; + + public LTHash(CompanionHashState hash) { + this.salt = SALT.getBytes(StandardCharsets.UTF_8); + this.hash = hash.hash(); + this.indexValueMap = new HashMap<>(hash.indexValueMap()); + this.add = new ArrayList<>(); + this.subtract = new ArrayList<>(); + } + + public void mix(byte[] indexMac, byte[] valueMac, RecordSync.Operation operation) { + var indexMacBase64 = Base64.getEncoder().encodeToString(indexMac); + var prevOp = indexValueMap.get(indexMacBase64); + if (operation == RecordSync.Operation.REMOVE) { + if (prevOp == null) { + return; + } + indexValueMap.remove(indexMacBase64, prevOp); + } else { + add.add(valueMac); + indexValueMap.put(indexMacBase64, valueMac); + } + if (prevOp != null) { + subtract.add(prevOp); + } + } + + public Result finish() { + var subtracted = perform(hash, false); + var added = perform(subtracted, true); + return new Result(added, indexValueMap); + } + + private byte[] perform(byte[] input, boolean sum) { + for (var item : sum ? add : subtract) { + input = perform(input, item, sum); + } + return input; + } + + private byte[] perform(byte[] input, byte[] buffer, boolean sum) { + var expanded = Hkdf.extractAndExpand(buffer, salt, EXPAND_SIZE); + var eRead = ByteBuffer.wrap(input).order(ByteOrder.LITTLE_ENDIAN); + var tRead = ByteBuffer.wrap(expanded).order(ByteOrder.LITTLE_ENDIAN); + var write = ByteBuffer.allocate(input.length).order(ByteOrder.LITTLE_ENDIAN); + for (var index = 0; index < input.length; index += 2) { + var first = Short.toUnsignedInt(eRead.getShort(index)); + var second = Short.toUnsignedInt(tRead.getShort(index)); + write.putShort(index, (short) (sum ? first + second : first - second)); + } + var result = new byte[input.length]; + write.get(result); + return result; + } + + public record Result(byte[] hash, Map indexValueMap) { + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/MD5.java b/src/main/java/it/auties/whatsapp/crypto/MD5.java new file mode 100644 index 000000000..3a9452574 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/MD5.java @@ -0,0 +1,24 @@ +package it.auties.whatsapp.crypto; + + +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; + +public final class MD5 { + private static final String MD5 = "MD5"; + + public static byte[] calculate(String data) { + return calculate(data.getBytes(StandardCharsets.UTF_8)); + } + + public static byte[] calculate(byte[] data) { + try { + var digest = MessageDigest.getInstance(MD5); + digest.update(data); + return digest.digest(); + } catch (NoSuchAlgorithmException exception) { + throw new UnsupportedOperationException("Missing md5 implementation", exception); + } + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/PBKDF2.java b/src/main/java/it/auties/whatsapp/crypto/PBKDF2.java new file mode 100644 index 000000000..a19edc417 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/PBKDF2.java @@ -0,0 +1,56 @@ +package it.auties.whatsapp.crypto; + +import javax.crypto.Mac; +import javax.crypto.spec.SecretKeySpec; +import java.security.GeneralSecurityException; +import java.security.NoSuchAlgorithmException; +import java.util.Arrays; + +public class PBKDF2 { + private static final String ALGORITHM = "HMACSHA1"; + + public static byte[] hmacSha1With8Bit(byte[] password, byte[] salt, int iterationCount, int keySizeBits) { + try { + var mac = Mac.getInstance(ALGORITHM); + var key = new SecretKeySpec(password, ALGORITHM); + mac.init(key); + var state = new byte[mac.getMacLength()]; + var keySize = keySizeBits / 8; + var blocks = (keySize + mac.getMacLength() - 1) / mac.getMacLength(); + var iBuf = new byte[4]; + var result = new byte[blocks * mac.getMacLength()]; + var offset = 0; + for(var i = 1; i <= blocks; ++i) { + var pos = 3; + while (++iBuf[pos] == 0) { + --pos; + } + + if (salt != null) { + mac.update(salt, 0, salt.length); + } + + mac.update(iBuf, 0, iBuf.length); + mac.doFinal(state, 0); + System.arraycopy(state, 0, result, offset, state.length); + + for(var count = 1; count < iterationCount; ++count) { + mac.update(state, 0, state.length); + mac.doFinal(state, 0); + + for(var j = 0; j != state.length; ++j) { + result[offset + j] ^= state[j]; + } + } + + offset += mac.getMacLength(); + } + + return Arrays.copyOf(result, keySize); + }catch (NoSuchAlgorithmException exception) { + throw new RuntimeException("Missing HMACSHA1 implementation", exception); + }catch (GeneralSecurityException exception) { + throw new RuntimeException(exception); + } + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/SessionBuilder.java b/src/main/java/it/auties/whatsapp/crypto/SessionBuilder.java new file mode 100644 index 000000000..2c506cd3d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/SessionBuilder.java @@ -0,0 +1,131 @@ +package it.auties.whatsapp.crypto; + +import it.auties.curve25519.Curve25519; +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.model.signal.keypair.ISignalKeyPair; +import it.auties.whatsapp.model.signal.keypair.SignalKeyPair; +import it.auties.whatsapp.model.signal.keypair.SignalSignedKeyPair; +import it.auties.whatsapp.model.signal.message.SignalPreKeyMessage; +import it.auties.whatsapp.model.signal.session.*; +import it.auties.whatsapp.util.Bytes; +import it.auties.whatsapp.util.Specification.Signal; +import it.auties.whatsapp.util.Validate; + +import java.nio.charset.StandardCharsets; +import java.util.Arrays; +import java.util.NoSuchElementException; +import java.util.Objects; +import java.util.concurrent.ConcurrentHashMap; + +public record SessionBuilder(SessionAddress address, Keys keys) { + public void createOutgoing(int id, byte[] identityKey, SignalSignedKeyPair signedPreKey, SignalSignedKeyPair preKey) { + Validate.isTrue(keys.hasTrust(address, identityKey), "Untrusted key", SecurityException.class); + Validate.isTrue(Curve25519.verifySignature(ISignalKeyPair.toCurveKey(identityKey), signedPreKey.keyPair() + .signalPublicKey(), signedPreKey.signature()), "Signature mismatch", SecurityException.class); + var baseKey = SignalKeyPair.random(); + var state = createState(true, + baseKey, + null, + identityKey, + preKey == null ? null : preKey.keyPair().signalPublicKey(), + signedPreKey.keyPair().signalPublicKey(), + id, + Signal.CURRENT_VERSION + ); + var pendingPreKey = new SessionPreKey( + preKey == null ? null : preKey.id(), + baseKey.signalPublicKey(), + signedPreKey.id() + ); + state.pendingPreKey(pendingPreKey); + keys.findSessionByAddress(address) + .map(Session::closeCurrentState) + .orElseGet(this::createSession) + .addState(state); + } + + public SessionState createState(boolean isInitiator, SignalKeyPair ourEphemeralKey, SignalKeyPair ourSignedKey, byte[] theirIdentityPubKey, byte[] theirEphemeralPubKey, byte[] theirSignedPubKey, int registrationId, int version) { + if (isInitiator) { + Validate.isTrue(ourSignedKey == null, "Our signed key should be null"); + ourSignedKey = ourEphemeralKey; + } else { + Validate.isTrue(theirSignedPubKey == null, "Their signed public key should be null"); + theirSignedPubKey = theirEphemeralPubKey; + } + var signedSecret = Curve25519.sharedKey(ISignalKeyPair.toCurveKey(theirSignedPubKey), keys.identityKeyPair() + .privateKey()); + var identitySecret = Curve25519.sharedKey(ISignalKeyPair.toCurveKey(theirIdentityPubKey), ourSignedKey.privateKey()); + var signedIdentitySecret = Curve25519.sharedKey(ISignalKeyPair.toCurveKey(theirSignedPubKey), ourSignedKey.privateKey()); + var ephemeralSecret = theirEphemeralPubKey == null || ourEphemeralKey == null ? null : Curve25519.sharedKey(ISignalKeyPair.toCurveKey(theirEphemeralPubKey), ourEphemeralKey.privateKey()); + var sharedSecret = createStateSecret(isInitiator, signedSecret, identitySecret, signedIdentitySecret, ephemeralSecret); + var masterKey = Hkdf.deriveSecrets(sharedSecret, "WhisperText".getBytes(StandardCharsets.UTF_8)); + var state = createState(isInitiator, ourEphemeralKey, ourSignedKey, theirIdentityPubKey, theirEphemeralPubKey, theirSignedPubKey, registrationId, version, masterKey); + return isInitiator ? calculateSendingRatchet(state, theirSignedPubKey) : state; + } + + private Session createSession() { + var session = new Session(); + keys.putSession(address, session); + return session; + } + + private byte[] createStateSecret(boolean isInitiator, byte[] signedSecret, byte[] identitySecret, byte[] signedIdentitySecret, byte[] ephemeralSecret) { + var header = new byte[32]; + Arrays.fill(header, (byte) 0xff); + return Bytes.concat( + header, + isInitiator ? signedSecret : identitySecret, + isInitiator ? identitySecret : signedSecret, + signedIdentitySecret, + ephemeralSecret + ); + } + + private SessionState createState(boolean isInitiator, SignalKeyPair ourEphemeralKey, SignalKeyPair ourSignedKey, byte[] theirIdentityPubKey, byte[] theirEphemeralPubKey, byte[] theirSignedPubKey, int registrationId, int version, byte[][] masterKey) { + return new SessionState( + version, + registrationId, + isInitiator ? ourEphemeralKey.signalPublicKey() : theirEphemeralPubKey, + theirIdentityPubKey, + new ConcurrentHashMap<>(), + masterKey[0], + null, + isInitiator ? SignalKeyPair.random() : ourSignedKey, + Objects.requireNonNull(theirSignedPubKey), + 0, + false + ); + } + + private SessionState calculateSendingRatchet(SessionState state, byte[] theirSignedPubKey) { + var initSecret = Curve25519.sharedKey(ISignalKeyPair.toCurveKey(theirSignedPubKey), state.ephemeralKeyPair() + .privateKey()); + var initKey = Hkdf.deriveSecrets(initSecret, state.rootKey(), "WhisperRatchet".getBytes(StandardCharsets.UTF_8)); + var key = state.ephemeralKeyPair().signalPublicKey(); + var chain = new SessionChain(-1, initKey[1]); + return state.addChain(key, chain).rootKey(initKey[0]); + } + + public void createIncoming(Session session, SignalPreKeyMessage message) { + Validate.isTrue(keys.hasTrust(address, message.identityKey()), "Untrusted key", SecurityException.class); + if (session.hasState(message.version(), message.baseKey())) { + return; + } + var preKeyPair = keys.findPreKeyById(message.preKeyId()) + .orElse(null); + var signedPreKeyPair = keys.findSignedKeyPairById(message.signedPreKeyId()) + .orElseThrow(() -> new NoSuchElementException("Cannot find signed pre key with id %s".formatted(message.signedPreKeyId()))); + session.closeCurrentState(); + var nextState = createState( + false, + preKeyPair != null ? preKeyPair.toGenericKeyPair() : null, + signedPreKeyPair == null ? null : signedPreKeyPair.toGenericKeyPair(), + message.identityKey(), + message.baseKey(), + null, + message.registrationId(), + message.version() + ); + session.addState(nextState); + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/SessionCipher.java b/src/main/java/it/auties/whatsapp/crypto/SessionCipher.java new file mode 100644 index 000000000..c05241225 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/SessionCipher.java @@ -0,0 +1,194 @@ +package it.auties.whatsapp.crypto; + +import it.auties.whatsapp.controller.Keys; +import it.auties.whatsapp.exception.HmacValidationException; +import it.auties.whatsapp.model.signal.keypair.ISignalKeyPair; +import it.auties.whatsapp.model.signal.keypair.SignalKeyPair; +import it.auties.whatsapp.model.signal.message.SignalMessage; +import it.auties.whatsapp.model.signal.message.SignalMessageSpec; +import it.auties.whatsapp.model.signal.message.SignalPreKeyMessage; +import it.auties.whatsapp.model.signal.session.Session; +import it.auties.whatsapp.model.signal.session.SessionAddress; +import it.auties.whatsapp.model.signal.session.SessionChain; +import it.auties.whatsapp.model.signal.session.SessionState; +import it.auties.whatsapp.util.Bytes; +import it.auties.whatsapp.util.Specification.Signal; +import it.auties.whatsapp.util.Validate; + +import java.nio.charset.StandardCharsets; +import java.util.Arrays; +import java.util.NoSuchElementException; +import java.util.Optional; +import java.util.function.Supplier; + +import static it.auties.curve25519.Curve25519.sharedKey; +import static it.auties.whatsapp.util.Specification.Signal.*; + +public record SessionCipher(SessionAddress address, Keys keys) { + public CipheredMessageResult encrypt(byte[] data) { + if (data == null) { + return new CipheredMessageResult(null, Signal.UNAVAILABLE); + } + var currentState = loadSession().currentState() + .orElseThrow(() -> new NoSuchElementException("Missing session for address %s".formatted(address))); + Validate.isTrue(keys.hasTrust(address, currentState.remoteIdentityKey()), "Untrusted key", SecurityException.class); + var chain = currentState.findChain(currentState.ephemeralKeyPair().signalPublicKey()) + .orElseThrow(() -> new NoSuchElementException("Missing chain for %s".formatted(address))); + fillMessageKeys(chain, chain.counter().get() + 1); + var currentKey = chain.messageKeys().get(chain.counter().get()); + var secrets = Hkdf.deriveSecrets(currentKey, "WhisperMessageKeys".getBytes(StandardCharsets.UTF_8)); + chain.messageKeys().remove(chain.counter().get()); + var iv = Arrays.copyOf(secrets[2], IV_LENGTH); + var encrypted = AesCbc.encrypt(iv, data, secrets[0]); + var encryptedMessageType = getMessageType(currentState); + var encryptedMessage = encrypt(currentState, chain, secrets[1], encrypted); + return new CipheredMessageResult(encryptedMessage, encryptedMessageType); + } + + private String getMessageType(SessionState currentState) { + return currentState.hasPreKey() ? Signal.PKMSG : Signal.MSG; + } + + private byte[] encrypt(SessionState state, SessionChain chain, byte[] key, byte[] encrypted) { + var message = new SignalMessage(state.ephemeralKeyPair().signalPublicKey(), chain.counter().get(), state.previousCounter(), encrypted); + message.setSignature(createMessageSignature(state, key, message)); + if (!state.hasPreKey()) { + return message.serialized(); + } + + var preKeyMessage = new SignalPreKeyMessage( + state.pendingPreKey().preKeyId(), + state.pendingPreKey().baseKey(), + keys.identityKeyPair().signalPublicKey(), + message.serialized(), + keys.registrationId(), + state.pendingPreKey().signedKeyId() + ); + return preKeyMessage.serialized(); + } + + private byte[] createMessageSignature(SessionState state, byte[] key, SignalMessage message) { + var encodedMessage = Bytes.concat( + message.serializedVersion(), + SignalMessageSpec.encode(message) + ); + var macInput = Bytes.concat( + keys.identityKeyPair().signalPublicKey(), + state.remoteIdentityKey(), + encodedMessage + ); + var sha256 = Hmac.calculateSha256(macInput, key); + return Arrays.copyOfRange(sha256, 0, MAC_LENGTH); + } + + private void fillMessageKeys(SessionChain chain, int counter) { + if (chain.counter().get() >= counter) { + return; + } + Validate.isTrue(counter - chain.counter() + .get() <= MAX_MESSAGES, "Message overflow: expected <= %s, got %s", MAX_MESSAGES, counter - chain.counter() + .get()); + Validate.isTrue(chain.key().get() != null, "Closed chain"); + var messagesHmac = Hmac.calculateSha256(new byte[]{1}, chain.key().get()); + chain.messageKeys().put(chain.counter().get() + 1, messagesHmac); + var keyHmac = Hmac.calculateSha256(new byte[]{2}, chain.key().get()); + chain.key().set(keyHmac); + chain.counter().getAndIncrement(); + fillMessageKeys(chain, counter); + } + + public byte[] decrypt(SignalPreKeyMessage message) { + var session = loadSession(this::createSession); + var builder = new SessionBuilder(address, keys); + builder.createIncoming(session, message); + var state = session.findState(message.version(), message.baseKey()) + .orElseThrow(() -> new NoSuchElementException("Missing state")); + return decrypt(message.signalMessage(), state); + } + + private Optional createSession() { + var newSession = new Session(); + keys.putSession(address, newSession); + return Optional.of(newSession); + } + + public byte[] decrypt(SignalMessage message) { + return loadSession().states() + .stream() + .map(state -> tryDecrypt(message, state)) + .flatMap(Optional::stream) + .findFirst() + .orElseThrow(() -> new NoSuchElementException("Cannot decrypt message: no suitable session found")); + } + + private Optional tryDecrypt(SignalMessage message, SessionState state) { + try { + Validate.isTrue(keys.hasTrust(address, state.remoteIdentityKey()), "Untrusted key"); + return Optional.of(decrypt(message, state)); + } catch (Throwable throwable) { + return Optional.empty(); + } + } + + private byte[] decrypt(SignalMessage message, SessionState state) { + maybeStepRatchet(message, state); + var chain = state.findChain(message.ephemeralPublicKey()) + .orElseThrow(() -> new NoSuchElementException("Invalid chain")); + fillMessageKeys(chain, message.counter()); + Validate.isTrue(chain.hasMessageKey(message.counter()), "Key used already or never filled"); + var messageKey = chain.messageKeys().get(message.counter()); + var secrets = Hkdf.deriveSecrets(messageKey, "WhisperMessageKeys".getBytes(StandardCharsets.UTF_8)); + var hmacValue = Bytes.concat( + state.remoteIdentityKey(), + keys.identityKeyPair().signalPublicKey(), + message.serialized() + ); + var hmacInput = Arrays.copyOfRange(hmacValue, 0, hmacValue.length - MAC_LENGTH); + var hmacSha256 = Hmac.calculateSha256(hmacInput, secrets[1]); + var hmac = Arrays.copyOf(hmacSha256, MAC_LENGTH); + Validate.isTrue(Arrays.equals(message.signature(), hmac), "message_decryption", HmacValidationException.class); + var iv = Arrays.copyOf(secrets[2], IV_LENGTH); + var plaintext = AesCbc.decrypt(iv, message.ciphertext(), secrets[0]); + state.pendingPreKey(null); + return plaintext; + } + + private void maybeStepRatchet(SignalMessage message, SessionState state) { + if (state.hasChain(message.ephemeralPublicKey())) { + return; + } + var previousRatchet = state.findChain(state.lastRemoteEphemeralKey()); + previousRatchet.ifPresent(chain -> { + fillMessageKeys(chain, state.previousCounter()); + chain.key().set(null); + }); + calculateRatchet(message, state, false); + var previousCounter = state.findChain(state.ephemeralKeyPair().signalPublicKey()); + previousCounter.ifPresent(chain -> { + state.previousCounter(chain.counter().get()); + state.removeChain(state.ephemeralKeyPair().signalPublicKey()); + }); + state.ephemeralKeyPair(SignalKeyPair.random()); + calculateRatchet(message, state, true); + state.lastRemoteEphemeralKey(message.ephemeralPublicKey()); + } + + private void calculateRatchet(SignalMessage message, SessionState state, boolean sending) { + var sharedSecret = sharedKey(ISignalKeyPair.toCurveKey(message.ephemeralPublicKey()), state.ephemeralKeyPair() + .privateKey()); + var masterKey = Hkdf.deriveSecrets(sharedSecret, state.rootKey(), "WhisperRatchet".getBytes(StandardCharsets.UTF_8), 2); + var chainKey = sending ? state.ephemeralKeyPair().signalPublicKey() : message.ephemeralPublicKey(); + state.addChain(chainKey, new SessionChain(-1, masterKey[1])); + state.rootKey(masterKey[0]); + } + + private Session loadSession() { + return loadSession(() -> keys.findSessionByAddress(new SessionAddress(address.name(), 0))); + } + + private Session loadSession(Supplier> defaultSupplier) { + return keys.findSessionByAddress(address) + .or(defaultSupplier) + .orElseThrow(() -> new NoSuchElementException("Missing session for: %s".formatted(address))); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/crypto/Sha1.java b/src/main/java/it/auties/whatsapp/crypto/Sha1.java new file mode 100644 index 000000000..ca206001a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/Sha1.java @@ -0,0 +1,24 @@ +package it.auties.whatsapp.crypto; + + +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; + +public final class Sha1 { + private static final String SHA_1 = "SHA-1"; + + public static byte[] calculate(String data) { + return calculate(data.getBytes(StandardCharsets.UTF_8)); + } + + public static byte[] calculate(byte[] data) { + try { + var digest = MessageDigest.getInstance(SHA_1); + digest.update(data); + return digest.digest(); + } catch (NoSuchAlgorithmException exception) { + throw new UnsupportedOperationException("Missing sha1 implementation"); + } + } +} diff --git a/src/main/java/it/auties/whatsapp/crypto/Sha256.java b/src/main/java/it/auties/whatsapp/crypto/Sha256.java new file mode 100644 index 000000000..668eba33d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/crypto/Sha256.java @@ -0,0 +1,24 @@ +package it.auties.whatsapp.crypto; + + +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; + +public final class Sha256 { + private static final String SHA_256 = "SHA-256"; + + public static byte[] calculate(String data) { + return calculate(data.getBytes(StandardCharsets.UTF_8)); + } + + public static byte[] calculate(byte[] data) { + try { + var digest = MessageDigest.getInstance(SHA_256); + digest.update(data); + return digest.digest(); + } catch (NoSuchAlgorithmException exception) { + throw new UnsupportedOperationException("Missing sha256 implementation"); + } + } +} diff --git a/src/main/java/it/auties/whatsapp/exception/HmacValidationException.java b/src/main/java/it/auties/whatsapp/exception/HmacValidationException.java new file mode 100644 index 000000000..a5292b599 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/exception/HmacValidationException.java @@ -0,0 +1,11 @@ +package it.auties.whatsapp.exception; + + +/** + * An unchecked exception that is thrown when a hmac signature cannot be validated + */ +public class HmacValidationException extends SecurityException { + public HmacValidationException(String location) { + super(location); + } +} diff --git a/src/main/java/it/auties/whatsapp/exception/RegistrationException.java b/src/main/java/it/auties/whatsapp/exception/RegistrationException.java new file mode 100644 index 000000000..0d2ba8e75 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/exception/RegistrationException.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.exception; + +import it.auties.whatsapp.model.response.RegistrationResponse; + +import java.util.Optional; + +/** + * This exception is thrown when a phone number cannot be registered by the Whatsapp API + */ +public class RegistrationException extends RuntimeException { + private final RegistrationResponse erroneousResponse; + + public RegistrationException(RegistrationResponse erroneousResponse, String message) { + super(message); + this.erroneousResponse = erroneousResponse; + } + + public Optional erroneousResponse() { + return Optional.ofNullable(erroneousResponse); + } +} diff --git a/src/main/java/it/auties/whatsapp/exception/RequestException.java b/src/main/java/it/auties/whatsapp/exception/RequestException.java new file mode 100644 index 000000000..b2e948926 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/exception/RequestException.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.exception; + +/** + * This exception is thrown when a request cannot be sent to Whatsapp's socket + */ +public class RequestException extends RuntimeException { + public RequestException(String message, Throwable cause) { + super(message, cause); + } + + public RequestException(Throwable cause) { + super(cause); + } +} diff --git a/src/main/java/it/auties/whatsapp/listener/Listener.java b/src/main/java/it/auties/whatsapp/listener/Listener.java new file mode 100644 index 000000000..f4ff1dacc --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/Listener.java @@ -0,0 +1,661 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.DisconnectReason; +import it.auties.whatsapp.api.SocketEvent; +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.model.action.Action; +import it.auties.whatsapp.model.call.Call; +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.contact.Contact; +import it.auties.whatsapp.model.contact.ContactStatus; +import it.auties.whatsapp.model.info.ChatMessageInfo; +import it.auties.whatsapp.model.info.MessageIndexInfo; +import it.auties.whatsapp.model.info.MessageInfo; +import it.auties.whatsapp.model.info.QuotedMessageInfo; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.mobile.CountryLocale; +import it.auties.whatsapp.model.newsletter.Newsletter; +import it.auties.whatsapp.model.node.Node; +import it.auties.whatsapp.model.privacy.PrivacySettingEntry; +import it.auties.whatsapp.model.setting.Setting; + +import java.net.URI; +import java.util.Collection; +import java.util.List; +import java.util.Map; + +/** + * This interface can be used to listen for events fired when new information is sent by + * WhatsappWeb's socket. A listener can be registered manually using + * {@link Whatsapp#addListener(Listener)}. Otherwise, it can be registered by annotating it with the + * {@link RegisterListener} annotation. To disable the latter, check out + * {@link Store#autodetectListeners()}. + */ +@SuppressWarnings("unused") +public interface Listener { + /** + * Called when the socket sends a node to Whatsapp + * + * @param whatsapp an instance to the calling api + * @param outgoing the non-null node that was just sent + */ + default void onNodeSent(Whatsapp whatsapp, Node outgoing) { + } + + /** + * Called when the socket sends a node to Whatsapp + * + * @param outgoing the non-null node that was just sent + */ + default void onNodeSent(Node outgoing) { + } + + /** + * Called when the socket receives a node from Whatsapp + * + * @param whatsapp an instance to the calling api + * @param incoming the non-null node that was just received + */ + default void onNodeReceived(Whatsapp whatsapp, Node incoming) { + } + + /** + * Called when the socket receives a node from Whatsapp + * + * @param incoming the non-null node that was just received + */ + default void onNodeReceived(Node incoming) { + } + + /** + * Called when the socket successfully establishes a connection and logs in into an account. When + * this event is called, any data, including chats and contact, is not guaranteed to be already in + * memory. Instead, {@link OnChats#onChats(Whatsapp, Collection)} ()} and + * {@link OnContacts#onContacts(Whatsapp, Collection)} ()} should be used. + * + * @param whatsapp an instance to the calling api + */ + default void onLoggedIn(Whatsapp whatsapp) { + } + + /** + * Called when the socket successfully establishes a connection and logs in into an account. When + * this event is called, any data, including chats and contact, is not guaranteed to be already in + * memory. Instead, {@link Listener#onChats(Collection)} and + * {@link Listener#onContacts(Collection)} should be used. + */ + default void onLoggedIn() { + } + + /** + * Called when an updated list of properties is received. This method is called both when a + * connection is established with WhatsappWeb and when new props are available. In the latter case + * though, this object should be considered as partial and is guaranteed to contain only updated + * entries. + * + * @param whatsapp an instance to the calling api + * @param metadata the updated list of properties + */ + default void onMetadata(Whatsapp whatsapp, Map metadata) { + } + + /** + * Called when an updated list of properties is received. This method is called both when a + * connection is established with WhatsappWeb and when new props are available. In the latter case + * though, this object should be considered as partial and is guaranteed to contain only updated + * entries. + * + * @param metadata the updated list of properties + */ + default void onMetadata(Map metadata) { + } + + /** + * Called when the socket successfully disconnects from WhatsappWeb's Socket + * + * @param whatsapp an instance to the calling api + * @param reason the errorReason why the session was disconnected + */ + default void onDisconnected(Whatsapp whatsapp, DisconnectReason reason) { + } + + + /** + * Called when the socket successfully disconnects from WhatsappWeb's Socket + * + * @param reason the errorReason why the session was disconnected + */ + default void onDisconnected(DisconnectReason reason) { + } + + /** + * Called when the socket receives a sync from Whatsapp. + * + * @param whatsapp an instance to the calling api + * @param action the sync that was executed + * @param messageIndexInfo the data about this action + */ + default void onAction(Whatsapp whatsapp, Action action, MessageIndexInfo messageIndexInfo) { + } + + /** + * Called when the socket receives a sync from Whatsapp. + * + * @param action the sync that was executed + * @param messageIndexInfo the data about this action + */ + default void onAction(Action action, MessageIndexInfo messageIndexInfo) { + } + + /** + * Called when the socket receives a setting change from Whatsapp. + * + * @param whatsapp an instance to the calling api + * @param setting the setting that was toggled + */ + default void onSetting(Whatsapp whatsapp, Setting setting) { + } + + /** + * Called when the socket receives a setting change from Whatsapp. + * + * @param setting the setting that was toggled + */ + default void onSetting(Setting setting) { + } + + /** + * Called when the socket receives new features from Whatsapp. + * + * @param whatsapp an instance to the calling api + * @param features the non-null features that were sent + */ + default void onFeatures(Whatsapp whatsapp, List features) { + } + + + /** + * Called when the socket receives new features from Whatsapp. + * + * @param features the non-null features that were sent + */ + default void onFeatures(List features) { + } + + /** + * Called when the socket receives all the contacts from WhatsappWeb's Socket + * + * @param whatsapp an instance to the calling api + * @param contacts the contacts + */ + default void onContacts(Whatsapp whatsapp, Collection contacts) { + } + + /** + * Called when the socket receives all the contacts from WhatsappWeb's Socket + * + * @param contacts the contacts + */ + default void onContacts(Collection contacts) { + } + + /** + * Called when the socket receives an update regarding the presence of a contact + * + * @param whatsapp an instance to the calling api + * @param chat the chat that this update regards + * @param jid the contact that this update regards + * @param status the new status of the contact + */ + default void onContactPresence(Whatsapp whatsapp, Chat chat, Jid jid, ContactStatus status) { + } + + /** + * Called when the socket receives an update regarding the presence of a contact + * + * @param chat the chat that this update regards + * @param jid the contact that this update regards + * @param status the new status of the contact + */ + default void onContactPresence(Chat chat, Jid jid, ContactStatus status) { + } + + /** + * Called when the socket receives all the chats from WhatsappWeb's Socket. When this event is + * fired, it is guaranteed that all metadata excluding messages will be present. If you also need + * the messages to be loaded, please refer to {@link Listener#onChatMessagesSync(Chat, boolean)}. + * Particularly old chats may come later through + * {@link Listener#onChatMessagesSync(Chat, boolean)} + * + * @param whatsapp an instance to the calling api + * @param chats the chats + */ + default void onChats(Whatsapp whatsapp, Collection chats) { + } + + /** + * Called when the socket receives all the chats from WhatsappWeb's Socket. When this event is + * fired, it is guaranteed that all metadata excluding messages will be present. To access this + * data use {@link Store#chats()}. If you also need the messages to be loaded, please refer to + * {@link Listener#onChatMessagesSync(Chat, boolean)}. Particularly old chats may come later + * through {@link Listener#onChatMessagesSync(Chat, boolean)}. + * + * @param chats the chats + */ + default void onChats(Collection chats) { + } + + + /** + * Called when the socket receives all the newsletters from WhatsappWeb's Socket + * + * @param whatsapp an instance to the calling api + * @param newsletters the newsletters + */ + default void onNewsletters(Whatsapp whatsapp, Collection newsletters) { + } + + /** + * Called when the socket receives all the newsletters from WhatsappWeb's Socket + * + * @param newsletters the newsletters + */ + default void onNewsletters(Collection newsletters) { + } + + /** + * Called when the socket receives the messages for a chat. This method is only called when the QR + * is first scanned and history is being synced. From all subsequent runs, the messages will + * already in the chat on startup. + * + * @param whatsapp an instance to the calling api + * @param chat the chat + * @param last whether the messages in this chat are complete or there are more coming + */ + default void onChatMessagesSync(Whatsapp whatsapp, Chat chat, boolean last) { + } + + /** + * Called when the socket receives the message for a chat This method is only called when the QR + * is first scanned and history is being synced. From all subsequent runs, the messages will + * already in the chat on startup. + * + * @param chat the chat + * @param last whether the messages in this chat are complete or there are more coming + */ + default void onChatMessagesSync(Chat chat, boolean last) { + } + + /** + * Called when the socket receives the sync percentage for the full or recent chunk of messages. + * This method is only called when the QR is first scanned and history is being synced. + * + * @param percentage the percentage synced up to now + * @param recent whether the sync is about the recent messages or older messages + */ + default void onHistorySyncProgress(int percentage, boolean recent) { + } + + /** + * Called when the socket receives the sync percentage for the full or recent chunk of messages. + * This method is only called when the QR is first scanned and history is being synced. + * + * @param whatsapp an instance to the calling api + * @param percentage the percentage synced up to now + * @param recent whether the sync is about the recent messages or older messages + */ + default void onHistorySyncProgress(Whatsapp whatsapp, int percentage, boolean recent) { + } + + /** + * Called when a new message is received in a chat + * + * @param whatsapp an instance to the calling api + * @param info the message that was sent + */ + default void onNewMessage(Whatsapp whatsapp, MessageInfo info) { + } + + /** + * Called when a new message is received in a chat + * + * @param info the message that was sent + */ + default void onNewMessage(MessageInfo info) { + } + + /** + * Called when a message is deleted + * + * @param whatsapp an instance to the calling api + * @param info the message that was deleted + * @param everyone whether this message was deleted by you only for yourself or whether the + * message was permanently removed + */ + default void onMessageDeleted(Whatsapp whatsapp, MessageInfo info, boolean everyone) { + } + + /** + * Called when a message is deleted + * + * @param info the message that was deleted + * @param everyone whether this message was deleted by you only for yourself or whether the + * message was permanently removed + */ + default void onMessageDeleted(MessageInfo info, boolean everyone) { + } + + /** + * Called when the status of a message changes inside a chat + * + * @param whatsapp an instance to the calling api + * @param info the message whose status changed + */ + default void onMessageStatus(Whatsapp whatsapp, MessageInfo info) { + } + + /** + * Called when the status of a message changes inside a chat + * + * @param info the message whose status changed + */ + default void onMessageStatus(MessageInfo info) { + } + + + /** + * Called when the socket receives all the status updated from WhatsappWeb's Socket. + * + * @param whatsapp an instance to the calling api + * @param status the status + */ + default void onStatus(Whatsapp whatsapp, Collection status) { + } + + /** + * Called when the socket receives all the status updated from WhatsappWeb's Socket. + * + * @param status the status + */ + default void onStatus(Collection status) { + } + + /** + * Called when the socket receives a new status from WhatsappWeb's Socket + * + * @param whatsapp an instance to the calling api + * @param status the new status message + */ + default void onNewStatus(Whatsapp whatsapp, ChatMessageInfo status) { + } + + /** + * Called when the socket receives a new status from WhatsappWeb's Socket + * + * @param status the new status message + */ + default void onNewStatus(ChatMessageInfo status) { + } + + /** + * Called when an event regarding the underlying is fired + * + * @param whatsapp an instance to the calling api + * @param event the event + */ + default void onSocketEvent(Whatsapp whatsapp, SocketEvent event) { + } + + /** + * Called when an event regarding the underlying is fired + * + * @param event the event + */ + default void onSocketEvent(SocketEvent event) { + } + + /** + * Called when a message answers a previous message + * + * @param response the response + * @param quoted the quoted message + */ + default void onMessageReply(ChatMessageInfo response, QuotedMessageInfo quoted) { + } + + /** + * Called when a message answers a previous message + * + * @param whatsapp an instance to the calling api + * @param response the response + * @param quoted the quoted message + */ + default void onMessageReply(Whatsapp whatsapp, ChatMessageInfo response, QuotedMessageInfo quoted) { + } + + /** + * Called when a contact's profile picture changes + * + * @param contact the contact whose pic changed + */ + default void onProfilePictureChanged(Contact contact) { + } + + + /** + * Called when a contact's profile picture changes + * + * @param whatsapp an instance to the calling api + * @param contact the contact whose pic changed + */ + default void onProfilePictureChanged(Whatsapp whatsapp, Contact contact) { + } + + /** + * Called when a group's picture changes + * + * @param group the group whose pic changed + */ + default void onGroupPictureChanged(Chat group) { + } + + /** + * Called when a group's picture changes + * + * @param whatsapp an instance to the calling api + * @param group the group whose pic changed + */ + default void onGroupPictureChanged(Whatsapp whatsapp, Chat group) { + } + + /** + * Called when the companion's name changes + * + * @param oldName the non-null old name + * @param newName the non-null new name + */ + default void onNameChanged(String oldName, String newName) { + } + + /** + * Called when the companion's name changes + * + * @param whatsapp an instance to the calling api + * @param oldName the non-null old name + * @param newName the non-null new name + */ + default void onNameChanged(Whatsapp whatsapp, String oldName, String newName) { + } + + /** + * Called when the companion's about changes + * + * @param oldAbout the non-null old about + * @param newAbout the non-null new about + */ + default void onAboutChanged(String oldAbout, String newAbout) { + } + + /** + * Called when the companion's about changes + * + * @param whatsapp an instance to the calling api + * @param oldAbout the non-null old about + * @param newAbout the non-null new about + */ + default void onAboutChanged(Whatsapp whatsapp, String oldAbout, String newAbout) { + } + + /** + * Called when the companion's picture changes + * + * @param oldPicture the non-null old picture + * @param newPicture the non-null new picture + */ + default void onProfilePictureChanged(URI oldPicture, URI newPicture) { + } + + /** + * Called when the companion's picture changes + * + * @param whatsapp an instance to the calling api + * @param oldPicture the non-null old picture + * @param newPicture the non-null new picture + */ + default void onProfilePictureChanged(Whatsapp whatsapp, URI oldPicture, URI newPicture) { + } + + /** + * Called when the companion's locale changes + * + * @param oldLocale the non-null old locale + * @param newLocale the non-null new picture + */ + default void onLocaleChanged(CountryLocale oldLocale, CountryLocale newLocale) { + } + + /** + * Called when the companion's locale changes + * + * @param whatsapp an instance to the calling api + * @param oldLocale the non-null old locale + * @param newLocale the non-null new picture + */ + default void onLocaleChanged(Whatsapp whatsapp, CountryLocale oldLocale, CountryLocale newLocale) { + } + + /** + * Called when a contact is blocked or unblocked + * + * @param contact the non-null contact + */ + default void onContactBlocked(Contact contact) { + } + + /** + * Called when a contact is blocked or unblocked + * + * @param whatsapp an instance to the calling api + * @param contact the non-null contact + */ + default void onContactBlocked(Whatsapp whatsapp, Contact contact) { + } + + /** + * Called when the socket receives a new contact + * + * @param whatsapp an instance to the calling api + * @param contact the new contact + */ + default void onNewContact(Whatsapp whatsapp, Contact contact) { + } + + /** + * Called when the socket receives a new contact + * + * @param contact the new contact + */ + default void onNewContact(Contact contact) { + } + + /** + * Called when a privacy setting is modified + * + * @param whatsapp an instance to the calling api + * @param oldPrivacyEntry the old entry + * @param newPrivacyEntry the new entry + */ + default void onPrivacySettingChanged(Whatsapp whatsapp, PrivacySettingEntry oldPrivacyEntry, PrivacySettingEntry newPrivacyEntry) { + + } + + /** + * Called when a privacy setting is modified + * + * @param oldPrivacyEntry the old entry + * @param newPrivacyEntry the new entry + */ + default void onPrivacySettingChanged(PrivacySettingEntry oldPrivacyEntry, PrivacySettingEntry newPrivacyEntry) { + + } + + /** + * Called when the list of companion devices is updated + * + * @param whatsapp an instance to the calling api + * @param devices the non-null devices + */ + default void onLinkedDevices(Whatsapp whatsapp, Collection devices) { + + } + + /** + * Called when the list of companion devices is updated + * + * @param devices the non-null devices + */ + default void onLinkedDevices(Collection devices) { + + } + + /** + * Called when an OTP is requested from a new device + * Only works on the mobile API + * + * @param code the registration code + */ + default void onRegistrationCode(long code) { + + } + + /** + * Called when an OTP is requested from a new device + * Only works on the mobile API + * + * @param whatsapp an instance to the calling api + * @param code the registration code + */ + default void onRegistrationCode(Whatsapp whatsapp, long code) { + + } + + /** + * Called when a phone call arrives + * + * @param call the non-null phone call + */ + default void onCall(Call call) { + + } + + /** + * Called when a phone call arrives + * + * @param whatsapp an instance to the calling api + * @param call the non-null phone call + */ + default void onCall(Whatsapp whatsapp, Call call) { + + } +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnAction.java b/src/main/java/it/auties/whatsapp/listener/OnAction.java new file mode 100644 index 000000000..675f3785b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnAction.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.action.Action; +import it.auties.whatsapp.model.info.MessageIndexInfo; + +public interface OnAction extends Listener { + /** + * Called when the socket receives a sync from Whatsapp. + * + * @param action the sync that was executed + * @param messageIndexInfo the data about this action + */ + @Override + void onAction(Action action, MessageIndexInfo messageIndexInfo); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnCall.java b/src/main/java/it/auties/whatsapp/listener/OnCall.java new file mode 100644 index 000000000..0653e5865 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnCall.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.call.Call; + +public interface OnCall extends Listener { + /** + * Called when a phone call arrives + * + * @param call the non-null phone call + */ + @Override + void onCall(Call call); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnChatMessagesSync.java b/src/main/java/it/auties/whatsapp/listener/OnChatMessagesSync.java new file mode 100644 index 000000000..6ac9d371c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnChatMessagesSync.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.chat.Chat; + +public interface OnChatMessagesSync extends Listener { + /** + * Called when the socket receives the recent message for a chat + * + * @param chat the chat + * @param last whether the messages in this chat are complete or there are more coming + */ + @Override + void onChatMessagesSync(Chat chat, boolean last); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnChats.java b/src/main/java/it/auties/whatsapp/listener/OnChats.java new file mode 100644 index 000000000..136e965a6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnChats.java @@ -0,0 +1,20 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.controller.Store; +import it.auties.whatsapp.model.chat.Chat; + +import java.util.Collection; + +public interface OnChats extends Listener { + /** + * Called when the socket receives all the chats from WhatsappWeb's WebSocket. When this event is + * fired, it is guaranteed that all metadata excluding messages will be present. To access this + * data use {@link Store#chats()}. If you also need the messages to be loaded, please refer to + * {@link Listener#onChatMessagesSync(Chat, boolean)}. Particularly old chats may come later + * through {@link Listener#onChatMessagesSync(Chat, boolean)}. + * + * @param chats the chats + */ + @Override + void onChats(Collection chats); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnContactBlocked.java b/src/main/java/it/auties/whatsapp/listener/OnContactBlocked.java new file mode 100644 index 000000000..9ff2d27cb --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnContactBlocked.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.contact.Contact; + +public interface OnContactBlocked extends Listener { + /** + * Called when a contact is blocked or unblocked + * + * @param contact the non-null contact + */ + @Override + void onContactBlocked(Contact contact); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnContactPictureChanged.java b/src/main/java/it/auties/whatsapp/listener/OnContactPictureChanged.java new file mode 100644 index 000000000..f742918a5 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnContactPictureChanged.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.contact.Contact; + +public interface OnContactPictureChanged extends Listener { + /** + * Called when a contact's profile picture changes + * + * @param contact the contact whose pic changed + */ + @Override + void onProfilePictureChanged(Contact contact); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnContactPresence.java b/src/main/java/it/auties/whatsapp/listener/OnContactPresence.java new file mode 100644 index 000000000..5f3ffbc6a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnContactPresence.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.contact.ContactStatus; +import it.auties.whatsapp.model.jid.Jid; + +public interface OnContactPresence extends Listener { + /** + * Called when the socket receives an update regarding the presence of a contact + * + * @param chat the chat that this update regards + * @param jid the contact that this update regards + * @param status the new status of the contact + */ + @Override + void onContactPresence(Chat chat, Jid jid, ContactStatus status); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnContacts.java b/src/main/java/it/auties/whatsapp/listener/OnContacts.java new file mode 100644 index 000000000..e40c359d3 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnContacts.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + + +import it.auties.whatsapp.model.contact.Contact; + +import java.util.Collection; + +public interface OnContacts extends Listener { + /** + * Called when the socket receives all the contacts from WhatsappWeb's WebSocket + * + * @param contacts the contacts + */ + @Override + void onContacts(Collection contacts); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnDisconnected.java b/src/main/java/it/auties/whatsapp/listener/OnDisconnected.java new file mode 100644 index 000000000..cf2010ca8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnDisconnected.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.DisconnectReason; + +public interface OnDisconnected extends Listener { + /** + * Called when the socket successfully disconnects from WhatsappWeb's WebSocket + * + * @param reason the errorReason why the session was disconnected + */ + @Override + void onDisconnected(DisconnectReason reason); +} + diff --git a/src/main/java/it/auties/whatsapp/listener/OnFeatures.java b/src/main/java/it/auties/whatsapp/listener/OnFeatures.java new file mode 100644 index 000000000..8d02ebb29 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnFeatures.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import java.util.List; + +public interface OnFeatures extends Listener { + /** + * Called when the socket receives new features from Whatsapp. + * + * @param features the non-null features that were sent + */ + @Override + void onFeatures(List features); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnGroupPictureChange.java b/src/main/java/it/auties/whatsapp/listener/OnGroupPictureChange.java new file mode 100644 index 000000000..b12b15aff --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnGroupPictureChange.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.chat.Chat; + +public interface OnGroupPictureChange extends Listener { + /** + * Called when a group's picture changes + * + * @param group the group whose pic changed + */ + @Override + void onGroupPictureChanged(Chat group); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnHistorySyncProgress.java b/src/main/java/it/auties/whatsapp/listener/OnHistorySyncProgress.java new file mode 100644 index 000000000..2b926c7ad --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnHistorySyncProgress.java @@ -0,0 +1,12 @@ +package it.auties.whatsapp.listener; + +public interface OnHistorySyncProgress extends Listener { + /** + * Called when the socket receives the sync percentage for the full or recent chunk of messages. + * This method is only called when the QR is first scanned and history is being synced. + * + * @param percentage the percentage synced up to now + * @param recent whether the sync is about the recent messages or older messages + */ + void onHistorySyncProgress(int percentage, boolean recent); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnLinkedDevices.java b/src/main/java/it/auties/whatsapp/listener/OnLinkedDevices.java new file mode 100644 index 000000000..94e8edf1e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnLinkedDevices.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.jid.Jid; + +import java.util.Collection; + +public interface OnLinkedDevices extends Listener { + /** + * Called when the list of companion devices is updated + * + * @param devices the non-null devices + */ + @Override + void onLinkedDevices(Collection devices); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnLoggedIn.java b/src/main/java/it/auties/whatsapp/listener/OnLoggedIn.java new file mode 100644 index 000000000..76a40b17b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnLoggedIn.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import java.util.Collection; + +public interface OnLoggedIn extends Listener { + /** + * Called when the socket successfully establishes a connection and logs in into an account. When + * this event is called, any data, including chats and contact, is not guaranteed to be already in + * memory. Instead, {@link OnChats#onChats(Collection)} ()} and + * {@link OnContacts#onContacts(Collection)} ()} should be used. + */ + @Override + void onLoggedIn(); +} + diff --git a/src/main/java/it/auties/whatsapp/listener/OnMessageDeleted.java b/src/main/java/it/auties/whatsapp/listener/OnMessageDeleted.java new file mode 100644 index 000000000..e8abf25f1 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnMessageDeleted.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.info.MessageInfo; + +public interface OnMessageDeleted extends Listener { + /** + * Called when a message is deleted + * + * @param info the message that was deleted + * @param everyone whether this message was deleted by you only for yourself or whether the + * message was permanently removed + */ + @Override + void onMessageDeleted(MessageInfo info, boolean everyone); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnMessageReply.java b/src/main/java/it/auties/whatsapp/listener/OnMessageReply.java new file mode 100644 index 000000000..062cfd22c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnMessageReply.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.info.ChatMessageInfo; +import it.auties.whatsapp.model.info.QuotedMessageInfo; + +public interface OnMessageReply extends Listener { + /** + * Called when a message answers a previous message + * + * @param info the answer message + * @param quoted the quoted message + */ + @Override + void onMessageReply(ChatMessageInfo info, QuotedMessageInfo quoted); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnMessageStatus.java b/src/main/java/it/auties/whatsapp/listener/OnMessageStatus.java new file mode 100644 index 000000000..290b05d16 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnMessageStatus.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.info.MessageInfo; + +public interface OnMessageStatus extends Listener { + /** + * Called when the status of a message changes + * + * @param info the message whose status changed + */ + @Override + void onMessageStatus(MessageInfo info); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnMetadata.java b/src/main/java/it/auties/whatsapp/listener/OnMetadata.java new file mode 100644 index 000000000..157958386 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnMetadata.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + +import java.util.Map; + +public interface OnMetadata extends Listener { + /** + * Called when an updated list of properties is received. This method is called both when a + * connection is established with WhatsappWeb and when new props are available. In the latter case + * though, this object should be considered as partial and is guaranteed to contain only updated + * entries. + * + * @param metadata the updated list of properties + */ + @Override + void onMetadata(Map metadata); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnNewContact.java b/src/main/java/it/auties/whatsapp/listener/OnNewContact.java new file mode 100644 index 000000000..ba4adbf3c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnNewContact.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.contact.Contact; + +public interface OnNewContact extends Listener { + /** + * Called when the socket receives a new contact. There isn't an overloaded method with a Whatsapp + * parameter due to technical limitations. + * + * @param contact the new contact + */ + @Override + void onNewContact(Contact contact); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnNewMessage.java b/src/main/java/it/auties/whatsapp/listener/OnNewMessage.java new file mode 100644 index 000000000..b0043f524 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnNewMessage.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.info.MessageInfo; + +public interface OnNewMessage extends Listener { + /** + * Called when a new message is received in a chat + * + * @param info the message that was sent + */ + @Override + void onNewMessage(MessageInfo info); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnNewStatus.java b/src/main/java/it/auties/whatsapp/listener/OnNewStatus.java new file mode 100644 index 000000000..d58fd8903 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnNewStatus.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.info.ChatMessageInfo; + +public interface OnNewStatus extends Listener { + /** + * Called when the socket receives a new status from WhatsappWeb's Socket + * + * @param status the new status message + */ + @Override + void onNewStatus(ChatMessageInfo status); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnNewsletters.java b/src/main/java/it/auties/whatsapp/listener/OnNewsletters.java new file mode 100644 index 000000000..b16332303 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnNewsletters.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.newsletter.Newsletter; + +import java.util.Collection; + +public interface OnNewsletters extends Listener { + /** + * Called when the socket receives all the newsletters from WhatsappWeb's Socket + * + * @param newsletters the newsletters + */ + @Override + void onNewsletters(Collection newsletters); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnNodeReceived.java b/src/main/java/it/auties/whatsapp/listener/OnNodeReceived.java new file mode 100644 index 000000000..d952b0c80 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnNodeReceived.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.node.Node; + +public interface OnNodeReceived extends Listener { + /** + * Called when the socket receives a node from Whatsapp + * + * @param incoming the non-null node that was just received + */ + @Override + void onNodeReceived(Node incoming); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnNodeSent.java b/src/main/java/it/auties/whatsapp/listener/OnNodeSent.java new file mode 100644 index 000000000..3c06930be --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnNodeSent.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.node.Node; + +public interface OnNodeSent extends Listener { + /** + * Called when the socket sends a node to Whatsapp + * + * @param outgoing the non-null node that was just sent + */ + @Override + void onNodeSent(Node outgoing); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnPrivacySettingChanged.java b/src/main/java/it/auties/whatsapp/listener/OnPrivacySettingChanged.java new file mode 100644 index 000000000..c1bceedd1 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnPrivacySettingChanged.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.privacy.PrivacySettingEntry; + +public interface OnPrivacySettingChanged extends Listener { + /** + * Called when a privacy setting is modified + * + * @param oldPrivacyEntry the old entry + * @param newPrivacyEntry the new entry + */ + @Override + void onPrivacySettingChanged(PrivacySettingEntry oldPrivacyEntry, PrivacySettingEntry newPrivacyEntry); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnProfilePictureChanged.java b/src/main/java/it/auties/whatsapp/listener/OnProfilePictureChanged.java new file mode 100644 index 000000000..340fd767d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnProfilePictureChanged.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.listener; + +import java.net.URI; + +public interface OnProfilePictureChanged extends Listener { + /** + * Called when the companion's picture changes + * + * @param oldPicture the non-null old picture + * @param newPicture the non-null new picture + */ + @Override + void onProfilePictureChanged(URI oldPicture, URI newPicture); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnRegistrationCode.java b/src/main/java/it/auties/whatsapp/listener/OnRegistrationCode.java new file mode 100644 index 000000000..afab0c322 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnRegistrationCode.java @@ -0,0 +1,12 @@ +package it.auties.whatsapp.listener; + +public interface OnRegistrationCode extends Listener { + /** + * Called when an OTP is requested from a new device + * Only works on the mobile API + * + * @param code the registration code + */ + @Override + void onRegistrationCode(long code); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnSetting.java b/src/main/java/it/auties/whatsapp/listener/OnSetting.java new file mode 100644 index 000000000..66c831edf --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnSetting.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.setting.Setting; + +public interface OnSetting extends Listener { + /** + * Called when the socket receives a setting change from Whatsapp. + * + * @param setting the setting that was toggled + */ + @Override + void onSetting(Setting setting); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnSocketEvent.java b/src/main/java/it/auties/whatsapp/listener/OnSocketEvent.java new file mode 100644 index 000000000..73949c705 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnSocketEvent.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.SocketEvent; + +public interface OnSocketEvent extends Listener { + /** + * Called when an event regarding the underlying is fired + * + * @param event the event + */ + @Override + void onSocketEvent(SocketEvent event); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnStatus.java b/src/main/java/it/auties/whatsapp/listener/OnStatus.java new file mode 100644 index 000000000..c18feabb2 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnStatus.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.info.ChatMessageInfo; + +import java.util.Collection; + +public interface OnStatus extends Listener { + /** + * Called when the socket receives all the status updated from WhatsappWeb's Socket. + * + * @param status the status + */ + void onStatus(Collection status); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnUserAboutChanged.java b/src/main/java/it/auties/whatsapp/listener/OnUserAboutChanged.java new file mode 100644 index 000000000..509302bfc --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnUserAboutChanged.java @@ -0,0 +1,11 @@ +package it.auties.whatsapp.listener; + +public interface OnUserAboutChanged extends Listener { + /** + * Called when the companion's status changes + * + * @param oldAbout the non-null old about + * @param newAbout the non-null new about + */ + void onAboutChange(String oldAbout, String newAbout); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnUserLocaleChanged.java b/src/main/java/it/auties/whatsapp/listener/OnUserLocaleChanged.java new file mode 100644 index 000000000..8918af21b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnUserLocaleChanged.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.model.mobile.CountryLocale; + +public interface OnUserLocaleChanged extends Listener { + /** + * Called when the companion's locale changes + * + * @param oldLocale the non-null old locale + * @param newLocale the non-null new picture + */ + @Override + void onLocaleChanged(CountryLocale oldLocale, CountryLocale newLocale); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnUserNameChanged.java b/src/main/java/it/auties/whatsapp/listener/OnUserNameChanged.java new file mode 100644 index 000000000..72a1127bc --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnUserNameChanged.java @@ -0,0 +1,12 @@ +package it.auties.whatsapp.listener; + +public interface OnUserNameChanged extends Listener { + /** + * Called when the companion's name changes + * + * @param oldName the non-null old name + * @param newName the non-null new name + */ + @Override + void onNameChanged(String oldName, String newName); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappAboutChanged.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappAboutChanged.java new file mode 100644 index 000000000..8b3e136fc --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappAboutChanged.java @@ -0,0 +1,14 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +public interface OnWhatsappAboutChanged extends Listener { + /** + * Called when the companion's status changes + * + * @param whatsapp an instance to the calling api + * @param oldAbout the non-null old about + * @param newAbout the non-null new about + */ + void onAboutChange(Whatsapp whatsapp, String oldAbout, String newAbout); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappAction.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappAction.java new file mode 100644 index 000000000..eddeaf840 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappAction.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.action.Action; +import it.auties.whatsapp.model.info.MessageIndexInfo; + +public interface OnWhatsappAction extends Listener { + /** + * Called when the socket receives a sync from Whatsapp. + * + * @param whatsapp an instance to the calling api + * @param action the sync that was executed + * @param messageIndexInfo the data about this action + */ + @Override + void onAction(Whatsapp whatsapp, Action action, MessageIndexInfo messageIndexInfo); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappCall.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappCall.java new file mode 100644 index 000000000..99c97df61 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappCall.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.call.Call; + +public interface OnWhatsappCall extends Listener { + /** + * Called when a phone call arrives + * + * @param whatsapp an instance to the calling api + * @param call the non-null phone call + */ + @Override + void onCall(Whatsapp whatsapp, Call call); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappChatMessagesSync.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappChatMessagesSync.java new file mode 100644 index 000000000..faaaf6224 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappChatMessagesSync.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.chat.Chat; + +public interface OnWhatsappChatMessagesSync extends Listener { + /** + * Called when the socket receives the recent message for a chat + * + * @param whatsapp an instance to the calling api + * @param chat the chat + * @param last whether the messages in this chat are complete or there are more coming + */ + @Override + void onChatMessagesSync(Whatsapp whatsapp, Chat chat, boolean last); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappChats.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappChats.java new file mode 100644 index 000000000..670afdc8c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappChats.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.chat.Chat; + +import java.util.Collection; + +public interface OnWhatsappChats extends Listener { + /** + * Called when the socket receives all the chats from WhatsappWeb's Socket. When this event is + * fired, it is guaranteed that all metadata excluding messages will be present. If you also need + * the messages to be loaded, please refer to {@link Listener#onChatMessagesSync(Chat, boolean)}. + * Particularly old chats may come later through + * {@link Listener#onChatMessagesSync(Chat, boolean)} + * + * @param whatsapp an instance to the calling api + * @param chats the chats + */ + @Override + void onChats(Whatsapp whatsapp, Collection chats); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactBlocked.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactBlocked.java new file mode 100644 index 000000000..767822c06 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactBlocked.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.contact.Contact; + +public interface OnWhatsappContactBlocked extends Listener { + /** + * Called when a contact is blocked or unblocked + * + * @param whatsapp an instance to the calling api + * @param contact the non-null contact + */ + @Override + void onContactBlocked(Whatsapp whatsapp, Contact contact); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactPictureChanged.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactPictureChanged.java new file mode 100644 index 000000000..39d18f847 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactPictureChanged.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.contact.Contact; + +public interface OnWhatsappContactPictureChanged extends Listener { + /** + * Called when a contact's profile picture changes + * + * @param whatsapp an instance to the calling api + * @param contact the contact whose pic changed + */ + @Override + void onProfilePictureChanged(Whatsapp whatsapp, Contact contact); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactPresence.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactPresence.java new file mode 100644 index 000000000..26f69ec7b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappContactPresence.java @@ -0,0 +1,19 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.contact.ContactStatus; +import it.auties.whatsapp.model.jid.Jid; + +public interface OnWhatsappContactPresence extends Listener { + /** + * Called when the socket receives an update regarding the presence of a contact + * + * @param whatsapp an instance to the calling api + * @param chat the chat that this update regards + * @param jid the contact that this update regards + * @param status the new status of the contact + */ + @Override + void onContactPresence(Whatsapp whatsapp, Chat chat, Jid jid, ContactStatus status); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappContacts.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappContacts.java new file mode 100644 index 000000000..a20b6507e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappContacts.java @@ -0,0 +1,18 @@ +package it.auties.whatsapp.listener; + + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.contact.Contact; + +import java.util.Collection; + +public interface OnWhatsappContacts extends Listener { + /** + * Called when the socket receives all the contacts from WhatsappWeb's WebSocket + * + * @param whatsapp an instance to the calling api + * @param contacts the contacts + */ + @Override + void onContacts(Whatsapp whatsapp, Collection contacts); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappDisconnected.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappDisconnected.java new file mode 100644 index 000000000..f17ad7cdd --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappDisconnected.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.DisconnectReason; +import it.auties.whatsapp.api.Whatsapp; + +public interface OnWhatsappDisconnected extends Listener { + /** + * Called when the socket successfully disconnects from WhatsappWeb's WebSocket + * + * @param whatsapp an instance to the calling api + * @param reason the errorReason why the session was disconnected + */ + @Override + void onDisconnected(Whatsapp whatsapp, DisconnectReason reason); +} + diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappFeatures.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappFeatures.java new file mode 100644 index 000000000..735bfcaf7 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappFeatures.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +import java.util.List; + +public interface OnWhatsappFeatures extends Listener { + /** + * Called when the socket receives new features from Whatsapp. + * + * @param whatsapp an instance to the calling api + * @param features the non-null features that were sent + */ + @Override + void onFeatures(Whatsapp whatsapp, List features); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappGroupPictureChange.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappGroupPictureChange.java new file mode 100644 index 000000000..0c7b7c945 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappGroupPictureChange.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.chat.Chat; + +public interface OnWhatsappGroupPictureChange extends Listener { + /** + * Called when a group's picture changes + * + * @param whatsapp an instance to the calling api + * @param group the group whose pic changed + */ + @Override + void onGroupPictureChanged(Whatsapp whatsapp, Chat group); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappHistorySyncProgress.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappHistorySyncProgress.java new file mode 100644 index 000000000..17740b4bf --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappHistorySyncProgress.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +public interface OnWhatsappHistorySyncProgress extends Listener { + /** + * Called when the socket receives the sync percentage for the full or recent chunk of messages. + * This method is only called when the QR is first scanned and history is being synced. + * + * @param whatsapp an instance to the calling api + * @param percentage the percentage synced up to now + * @param recent whether the sync is about the recent messages or older messages + */ + @Override + void onHistorySyncProgress(Whatsapp whatsapp, int percentage, boolean recent); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappLinkedDevices.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappLinkedDevices.java new file mode 100644 index 000000000..6e11dcfc6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappLinkedDevices.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.jid.Jid; + +import java.util.Collection; + +public interface OnWhatsappLinkedDevices extends Listener { + /** + * Called when the list of companion devices is updated + * + * @param whatsapp an instance to the calling api + * @param devices the non-null devices + */ + @Override + void onLinkedDevices(Whatsapp whatsapp, Collection devices); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappLocaleChanged.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappLocaleChanged.java new file mode 100644 index 000000000..95dac22a6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappLocaleChanged.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.mobile.CountryLocale; + +public interface OnWhatsappLocaleChanged extends Listener { + /** + * Called when the companion's locale changes + * + * @param whatsapp an instance to the calling api + * @param oldLocale the non-null old locale + * @param newLocale the non-null new picture + */ + @Override + void onLocaleChanged(Whatsapp whatsapp, CountryLocale oldLocale, CountryLocale newLocale); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappLoggedIn.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappLoggedIn.java new file mode 100644 index 000000000..9500c0d1e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappLoggedIn.java @@ -0,0 +1,19 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +import java.util.Collection; + +public interface OnWhatsappLoggedIn extends Listener { + /** + * Called when the socket successfully establishes a connection and logs in into an account. When + * this event is called, any data, including chats and contact, is not guaranteed to be already in + * memory. Instead, {@link OnChats#onChats(Whatsapp, Collection)} ()} and + * {@link OnContacts#onContacts(Whatsapp, Collection)} ()} should be used. + * + * @param whatsapp an instance to the calling api + */ + @Override + void onLoggedIn(Whatsapp whatsapp); +} + diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappMediaStatus.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMediaStatus.java new file mode 100644 index 000000000..208f1192f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMediaStatus.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.info.ChatMessageInfo; + +import java.util.Collection; + +public interface OnWhatsappMediaStatus extends Listener { + /** + * Called when the socket receives all the status updated from WhatsappWeb's Socket. + * + * @param whatsapp an instance to the calling api + * @param status the status + */ + void onStatus(Whatsapp whatsapp, Collection status); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageDeleted.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageDeleted.java new file mode 100644 index 000000000..cae83c614 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageDeleted.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.info.MessageInfo; + +public interface OnWhatsappMessageDeleted extends Listener { + /** + * Called when a message is deleted + * + * @param whatsapp an instance to the calling api + * @param info the message that was deleted + * @param everyone whether this message was deleted by you only for yourself or whether the + * message was permanently removed + */ + @Override + void onMessageDeleted(Whatsapp whatsapp, MessageInfo info, boolean everyone); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageReply.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageReply.java new file mode 100644 index 000000000..b213b16cb --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageReply.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.info.ChatMessageInfo; +import it.auties.whatsapp.model.info.QuotedMessageInfo; + +public interface OnWhatsappMessageReply extends Listener { + /** + * Called when a message answers a previous message + * + * @param whatsapp an instance to the calling api + * @param info the answer message + * @param quoted the quoted message + */ + @Override + void onMessageReply(Whatsapp whatsapp, ChatMessageInfo info, QuotedMessageInfo quoted); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageStatus.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageStatus.java new file mode 100644 index 000000000..3f53759e8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMessageStatus.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.info.MessageInfo; + +public interface OnWhatsappMessageStatus extends Listener { + /** + * Called when the status of a message changes + * + * @param whatsapp an instance to the calling api + * @param info the message whose status changed + */ + @Override + void onMessageStatus(Whatsapp whatsapp, MessageInfo info); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappMetadata.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMetadata.java new file mode 100644 index 000000000..5d29a342e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappMetadata.java @@ -0,0 +1,19 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +import java.util.Map; + +public interface OnWhatsappMetadata extends Listener { + /** + * Called when an updated list of properties is received. This method is called both when a + * connection is established with WhatsappWeb and when new props are available. In the latter case + * though, this object should be considered as partial and is guaranteed to contain only updated + * entries. + * + * @param whatsapp an instance to the calling api + * @param metadata the updated list of properties + */ + @Override + void onMetadata(Whatsapp whatsapp, Map metadata); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappNameChanged.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNameChanged.java new file mode 100644 index 000000000..aebb7060a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNameChanged.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +public interface OnWhatsappNameChanged extends Listener { + /** + * Called when the companion's name changes + * + * @param whatsapp an instance to the calling api + * @param oldName the non-null old name + * @param newName the non-null new name + */ + @Override + void onNameChanged(Whatsapp whatsapp, String oldName, String newName); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewMessage.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewMessage.java new file mode 100644 index 000000000..7ef360cc2 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewMessage.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.info.MessageInfo; + +public interface OnWhatsappNewMessage extends Listener { + /** + * Called when a new message is received in a chat + * + * @param whatsapp an instance to the calling api + * @param info the message that was sent + */ + @Override + void onNewMessage(Whatsapp whatsapp, MessageInfo info); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewStatus.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewStatus.java new file mode 100644 index 000000000..a4136044f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewStatus.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.info.ChatMessageInfo; + +public interface OnWhatsappNewStatus extends Listener { + /** + * Called when the socket receives a new status from WhatsappWeb's Socket + * + * @param whatsapp an instance to the calling api + * @param status the new status message + */ + @Override + void onNewStatus(Whatsapp whatsapp, ChatMessageInfo status); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewsletters.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewsletters.java new file mode 100644 index 000000000..e53e1bb60 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNewsletters.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.newsletter.Newsletter; + +import java.util.Collection; + +public interface OnWhatsappNewsletters extends Listener { + /** + * Called when the socket receives all the newsletters from WhatsappWeb's Socket + * + * @param whatsapp an instance to the calling api + * @param newsletters the newsletters + */ + @Override + void onNewsletters(Whatsapp whatsapp, Collection newsletters); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappNodeReceived.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNodeReceived.java new file mode 100644 index 000000000..b38a1f186 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNodeReceived.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.node.Node; + +public interface OnWhatsappNodeReceived extends Listener { + /** + * Called when the socket receives a node from Whatsapp + * + * @param whatsapp an instance to the calling api + * @param incoming the non-null node that was just received + */ + @Override + void onNodeReceived(Whatsapp whatsapp, Node incoming); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappNodeSent.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNodeSent.java new file mode 100644 index 000000000..ca9470919 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappNodeSent.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.node.Node; + +public interface OnWhatsappNodeSent extends Listener { + /** + * Called when the socket sends a node to Whatsapp + * + * @param whatsapp an instance to the calling api + * @param outgoing the non-null node that was just sent + */ + @Override + void onNodeSent(Whatsapp whatsapp, Node outgoing); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappPrivacySettingChanged.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappPrivacySettingChanged.java new file mode 100644 index 000000000..d8ccdffce --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappPrivacySettingChanged.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.privacy.PrivacySettingEntry; + +public interface OnWhatsappPrivacySettingChanged extends Listener { + /** + * Called when a privacy setting is modified + * + * @param whatsapp an instance to the calling api + * @param oldPrivacyEntry the old entry + * @param newPrivacyEntry the new entry + */ + @Override + void onPrivacySettingChanged(Whatsapp whatsapp, PrivacySettingEntry oldPrivacyEntry, PrivacySettingEntry newPrivacyEntry); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappProfilePictureChanged.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappProfilePictureChanged.java new file mode 100644 index 000000000..1c36ab149 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappProfilePictureChanged.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +import java.net.URI; + +public interface OnWhatsappProfilePictureChanged extends Listener { + /** + * Called when the companion's picture changes + * + * @param whatsapp an instance to the calling api + * @param oldPicture the non-null old picture + * @param newPicture the non-null new picture + */ + @Override + void onProfilePictureChanged(Whatsapp whatsapp, URI oldPicture, URI newPicture); +} diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappRegistrationCode.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappRegistrationCode.java new file mode 100644 index 000000000..972929921 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappRegistrationCode.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +public interface OnWhatsappRegistrationCode extends Listener { + /** + * Called when an OTP is requested from a new device + * Only works on the mobile API + * + * @param whatsapp an instance to the calling api + * @param code the registration code + */ + @Override + void onRegistrationCode(Whatsapp whatsapp, long code); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappSetting.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappSetting.java new file mode 100644 index 000000000..8263c1f0d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappSetting.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.setting.Setting; + +public interface OnWhatsappSetting extends Listener { + /** + * Called when the socket receives a setting change from Whatsapp. + * + * @param whatsapp an instance to the calling api + * @param setting the setting that was toggled + */ + @Override + void onSetting(Whatsapp whatsapp, Setting setting); +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/listener/OnWhatsappSocketEvent.java b/src/main/java/it/auties/whatsapp/listener/OnWhatsappSocketEvent.java new file mode 100644 index 000000000..2ae6323c8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/OnWhatsappSocketEvent.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.SocketEvent; +import it.auties.whatsapp.api.Whatsapp; + +public interface OnWhatsappSocketEvent extends Listener { + /** + * Called when an event regarding the underlying is fired + * + * @param whatsapp an instance to the calling api + * @param event the event + */ + @Override + void onSocketEvent(Whatsapp whatsapp, SocketEvent event); +} diff --git a/src/main/java/it/auties/whatsapp/listener/RegisterListener.java b/src/main/java/it/auties/whatsapp/listener/RegisterListener.java new file mode 100644 index 000000000..560e5763b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/RegisterListener.java @@ -0,0 +1,20 @@ +package it.auties.whatsapp.listener; + +import it.auties.whatsapp.api.Whatsapp; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * An annotation used to specify that a {@link Listener} should be dected automatically by + * {@link Whatsapp}. For this annotation to be recognized, the target class should implement + * {@link Listener} and provide a no argument constructor. If any of those conditions aren't met, a + * {@link RuntimeException} will be thrown. + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.TYPE}) +public @interface RegisterListener { + +} diff --git a/src/main/java/it/auties/whatsapp/listener/processor/RegisterListenerProcessor.java b/src/main/java/it/auties/whatsapp/listener/processor/RegisterListenerProcessor.java new file mode 100644 index 000000000..b52945cee --- /dev/null +++ b/src/main/java/it/auties/whatsapp/listener/processor/RegisterListenerProcessor.java @@ -0,0 +1,120 @@ +package it.auties.whatsapp.listener.processor; + +import com.sun.source.util.TaskListener; +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.listener.Listener; +import it.auties.whatsapp.listener.RegisterListener; + +import javax.annotation.processing.AbstractProcessor; +import javax.annotation.processing.RoundEnvironment; +import javax.annotation.processing.SupportedSourceVersion; +import javax.lang.model.SourceVersion; +import javax.lang.model.element.*; +import javax.tools.Diagnostic; +import javax.tools.JavaFileObject; +import java.io.IOException; +import java.io.PrintStream; +import java.io.UncheckedIOException; +import java.util.Set; + +@SupportedSourceVersion(SourceVersion.RELEASE_21) +public class RegisterListenerProcessor extends AbstractProcessor implements TaskListener { + private static final String SIMPLE_CLASS_NAME = "ListenersInitializer"; + private static final String PACKAGE_NAME = Listener.class.getPackageName(); + private static final String QUALIFIED_CLASS_NAME = PACKAGE_NAME + ".ListenersInitializer"; + private static final String METHOD_NAME = "register"; + private static final String WHATSAPP_TYPE = Whatsapp.class.getName(); + private PrintStream outputStream; + + public boolean process(Set annotations, RoundEnvironment roundEnv) { + var annotated = roundEnv.getElementsAnnotatedWith(RegisterListener.class); + for (var element : annotated) { + if (!(element instanceof TypeElement typeElement)) { + this.processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Only classes and records can be annotated with @RegisterListener", element); + continue; + } + + if (typeElement.getModifiers().contains(Modifier.ABSTRACT)) { + this.processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Elements annotated with @RegisterListener cannot be abstract", element); + continue; + } + + var result = this.registerConstructors(typeElement); + if (result) { + continue; + } + + this.processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Elements annotated with @RegisterListener must provide a public no parameters constructor or only a Whatsapp instance", element); + } + + if (roundEnv.processingOver()) { + this.closeOutputFile(); + } + + return true; + } + + private void createOutputFile(Element owner) { + if (this.outputStream == null) { + try { + JavaFileObject resource = this.processingEnv.getFiler().createSourceFile(QUALIFIED_CLASS_NAME, owner); + this.outputStream = new PrintStream(resource.openOutputStream()); + this.outputStream.printf("package %s;%n", PACKAGE_NAME); + this.outputStream.printf("public class %s {%n", SIMPLE_CLASS_NAME); + this.outputStream.printf(" public static void %s(%s whatsapp) {%n", "register", WHATSAPP_TYPE); + } catch (IOException var3) { + throw new UncheckedIOException(var3); + } + } + } + + private void closeOutputFile() { + this.outputStream.println(" }"); + this.outputStream.println("}"); + this.outputStream.close(); + } + + private boolean registerConstructors(TypeElement classTree) { + for (var member : classTree.getEnclosedElements()) { + if (!(member instanceof ExecutableElement executableElement)) { + continue; + } + + if (!executableElement.getModifiers().contains(Modifier.PUBLIC) || executableElement.getKind() != ElementKind.CONSTRUCTOR) { + continue; + } + + if (executableElement.getParameters().isEmpty()) { + this.createOutputFile(classTree); + this.outputStream.printf(" whatsapp.addListener(new %s());%n", classTree.getQualifiedName()); + return true; + } + + if (executableElement.getParameters().size() == 1 && this.isWhatsappType(executableElement)) { + this.createOutputFile(classTree); + this.outputStream.printf(" whatsapp.addListener(new %s(whatsapp));%n", classTree.getQualifiedName()); + return true; + } + } + + return false; + } + + private boolean isWhatsappType(ExecutableElement executableElement) { + var parameterType = executableElement.getParameters().getFirst(); + return parameterType instanceof TypeElement typeElement + && typeElement.getQualifiedName().contentEquals(WHATSAPP_TYPE); + } + + public Set getSupportedAnnotationTypes() { + return Set.of(RegisterListener.class.getName()); + } + + public static String qualifiedClassName() { + return QUALIFIED_CLASS_NAME; + } + + public static String methodName() { + return METHOD_NAME; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/Action.java b/src/main/java/it/auties/whatsapp/model/action/Action.java new file mode 100644 index 000000000..87612c6ca --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/Action.java @@ -0,0 +1,30 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model interface that represents an action + */ +public sealed interface Action extends ProtobufMessage permits AgentAction, AndroidUnsupportedActions, ArchiveChatAction, ChatAssignmentAction, ChatAssignmentOpenedStatusAction, ClearChatAction, ContactAction, DeleteChatAction, DeleteMessageForMeAction, LabelAssociationAction, LabelEditAction, MarkChatAsReadAction, MuteAction, NuxAction, PinAction, PrimaryVersionAction, QuickReplyAction, RecentEmojiWeightsAction, RemoveRecentStickerAction, StarAction, StickerAction, SubscriptionAction, TimeFormatAction, UserStatusMuteAction { + /** + * The name of this action + * + * @return a non-null string + */ + String indexName(); + + /** + * The version of this action + * + * @return a non-null int + */ + int actionVersion(); + + /** + * The type of this action + * + * @return a non-null type + */ + PatchType actionType(); +} diff --git a/src/main/java/it/auties/whatsapp/model/action/AgentAction.java b/src/main/java/it/auties/whatsapp/model/action/AgentAction.java new file mode 100644 index 000000000..da7ccb37d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/AgentAction.java @@ -0,0 +1,52 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.Optional; + +/** + * A model clas that represents an agent + */ +@ProtobufMessageName("SyncActionValue.AgentAction") +public record AgentAction( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Optional name, + @ProtobufProperty(index = 2, type = ProtobufType.INT32) + int deviceId, + @ProtobufProperty(index = 3, type = ProtobufType.BOOL) + boolean deleted +) implements Action { + + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "deviceAgent"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 7; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/AndroidUnsupportedActions.java b/src/main/java/it/auties/whatsapp/model/action/AndroidUnsupportedActions.java new file mode 100644 index 000000000..0084f7a3b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/AndroidUnsupportedActions.java @@ -0,0 +1,45 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model clas that represents unsupported actions for android + */ +@ProtobufMessageName("SyncActionValue.AndroidUnsupportedActions") +public record AndroidUnsupportedActions( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean allowed +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "android_unsupported_actions"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 4; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/ArchiveChatAction.java b/src/main/java/it/auties/whatsapp/model/action/ArchiveChatAction.java new file mode 100644 index 000000000..e71a899a9 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/ArchiveChatAction.java @@ -0,0 +1,50 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.ActionMessageRangeSync; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.Optional; + +/** + * A model clas that represents an archived chat + */ +@ProtobufMessageName("SyncActionValue.ArchiveChatAction") +public record ArchiveChatAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean archived, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Optional messageRange +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "archive"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 3; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/ChatAssignmentAction.java b/src/main/java/it/auties/whatsapp/model/action/ChatAssignmentAction.java new file mode 100644 index 000000000..086c43647 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/ChatAssignmentAction.java @@ -0,0 +1,48 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.Optional; + +/** + * A model clas that represents the assignment of a chat + */ +@ProtobufMessageName("SyncActionValue.ChatAssignmentAction") +public record ChatAssignmentAction( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Optional deviceAgentId +) implements Action { + + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "agentChatAssignment"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 7; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/ChatAssignmentOpenedStatusAction.java b/src/main/java/it/auties/whatsapp/model/action/ChatAssignmentOpenedStatusAction.java new file mode 100644 index 000000000..602d5365b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/ChatAssignmentOpenedStatusAction.java @@ -0,0 +1,45 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model clas that represents the assignment of a chat as opened + */ +@ProtobufMessageName("SyncActionValue.ChatAssignmentOpenedStatusAction") +public record ChatAssignmentOpenedStatusAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean chatOpened +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "agentChatAssignmentOpenedStatus"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 7; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/ClearChatAction.java b/src/main/java/it/auties/whatsapp/model/action/ClearChatAction.java new file mode 100644 index 000000000..cb099d23a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/ClearChatAction.java @@ -0,0 +1,48 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.ActionMessageRangeSync; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.Optional; + +/** + * A model clas that represents a cleared chat + */ +@ProtobufMessageName("SyncActionValue.ClearChatAction") +public record ClearChatAction( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Optional messageRange +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "clearChat"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 6; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/ContactAction.java b/src/main/java/it/auties/whatsapp/model/action/ContactAction.java new file mode 100644 index 000000000..ee98adcc3 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/ContactAction.java @@ -0,0 +1,60 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.Optional; + +/** + * A model clas that represents a new contact push name + */ +@ProtobufMessageName("SyncActionValue.ContactAction") +public record ContactAction( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Optional fullName, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + Optional firstName, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + Optional lidJid +) implements Action { + /** + * Returns the name of this contact + * + * @return an optional + */ + public Optional name() { + return fullName.or(this::firstName); + } + + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "contact"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 2; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/action/DeleteChatAction.java b/src/main/java/it/auties/whatsapp/model/action/DeleteChatAction.java new file mode 100644 index 000000000..b41fa6920 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/DeleteChatAction.java @@ -0,0 +1,48 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.ActionMessageRangeSync; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.Optional; + +/** + * A model clas that represents a deleted chat + */ +@ProtobufMessageName("SyncActionValue.DeleteChatAction") +public record DeleteChatAction( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Optional messageRange +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "deleteChat"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 6; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/DeleteMessageForMeAction.java b/src/main/java/it/auties/whatsapp/model/action/DeleteMessageForMeAction.java new file mode 100644 index 000000000..deead7313 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/DeleteMessageForMeAction.java @@ -0,0 +1,60 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + +/** + * A model clas that represents a message deleted for this client + */ +@ProtobufMessageName("SyncActionValue.DeleteMessageForMeAction") +public record DeleteMessageForMeAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean deleteMedia, + @ProtobufProperty(index = 2, type = ProtobufType.INT64) + long messageTimestampSeconds +) implements Action { + /** + * Returns when the deleted message was sent + * + * @return an optional + */ + public Optional messageTimestamp() { + return Clock.parseSeconds(messageTimestampSeconds); + } + + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "deleteMessageForMe"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 3; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/LabelAssociationAction.java b/src/main/java/it/auties/whatsapp/model/action/LabelAssociationAction.java new file mode 100644 index 000000000..743e343dc --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/LabelAssociationAction.java @@ -0,0 +1,45 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model clas that represents a label association + */ +@ProtobufMessageName("SyncActionValue.LabelAssociationAction") +public record LabelAssociationAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean labeled +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "label_message"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 3; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/LabelEditAction.java b/src/main/java/it/auties/whatsapp/model/action/LabelEditAction.java new file mode 100644 index 000000000..4fdefab46 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/LabelEditAction.java @@ -0,0 +1,51 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model clas that represents an edit to a label + */ +@ProtobufMessageName("SyncActionValue.LabelEditAction") +public record LabelEditAction( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String name, + @ProtobufProperty(index = 2, type = ProtobufType.INT32) + int color, + @ProtobufProperty(index = 3, type = ProtobufType.INT32) + int id, + @ProtobufProperty(index = 4, type = ProtobufType.BOOL) + boolean deleted +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "label_edit"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 3; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/MarkChatAsReadAction.java b/src/main/java/it/auties/whatsapp/model/action/MarkChatAsReadAction.java new file mode 100644 index 000000000..ff13d80cc --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/MarkChatAsReadAction.java @@ -0,0 +1,50 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.ActionMessageRangeSync; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.Optional; + +/** + * A model clas that represents a new read status for a chat + */ +@ProtobufMessageName("SyncActionValue.MarkChatAsReadAction") +public record MarkChatAsReadAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean read, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Optional messageRange +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "markChatAsRead"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 3; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/MuteAction.java b/src/main/java/it/auties/whatsapp/model/action/MuteAction.java new file mode 100644 index 000000000..506365628 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/MuteAction.java @@ -0,0 +1,63 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; +import java.util.OptionalLong; + +/** + * A model clas that represents a new mute status for a chat + */ +@ProtobufMessageName("SyncActionValue.MuteAction") +public record MuteAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean muted, + @ProtobufProperty(index = 2, type = ProtobufType.INT64) + OptionalLong muteEndTimestampSeconds, + @ProtobufProperty(index = 3, type = ProtobufType.BOOL) + boolean autoMuted +) implements Action { + /** + * Returns when the mute ends + * + * @return an optional + */ + public Optional muteEndTimestamp() { + return Clock.parseSeconds(muteEndTimestampSeconds.orElse(0)); + } + + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "mute"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 2; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/action/NuxAction.java b/src/main/java/it/auties/whatsapp/model/action/NuxAction.java new file mode 100644 index 000000000..d3297d57e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/NuxAction.java @@ -0,0 +1,46 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * Unknown + */ +@ProtobufMessageName("SyncActionValue.NuxAction") +public record NuxAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean acknowledged +) implements Action { + + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "nux"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 7; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/PinAction.java b/src/main/java/it/auties/whatsapp/model/action/PinAction.java new file mode 100644 index 000000000..7c8193565 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/PinAction.java @@ -0,0 +1,45 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model clas that represents a new pin status for a chat + */ +@ProtobufMessageName("SyncActionValue.PinAction") +public record PinAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean pinned +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "pin_v1"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 5; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/PrimaryVersionAction.java b/src/main/java/it/auties/whatsapp/model/action/PrimaryVersionAction.java new file mode 100644 index 000000000..bb7e1689c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/PrimaryVersionAction.java @@ -0,0 +1,45 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model class that contains the main Whatsapp version being used + */ +@ProtobufMessageName("SyncActionValue.PrimaryVersionAction") +public record PrimaryVersionAction( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String version +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "primary_version"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 7; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/QuickReplyAction.java b/src/main/java/it/auties/whatsapp/model/action/QuickReplyAction.java new file mode 100644 index 000000000..c69d53310 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/QuickReplyAction.java @@ -0,0 +1,55 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.List; + +/** + * A model clas that represents the addition or deletion of a quick reply + */ +@ProtobufMessageName("SyncActionValue.QuickReplyAction") +public record QuickReplyAction( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String shortcut, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String message, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + List keywords, + @ProtobufProperty(index = 4, type = ProtobufType.INT32) + int count, + @ProtobufProperty(index = 5, type = ProtobufType.BOOL) + boolean deleted +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "quick_reply"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 2; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/RecentEmojiWeightsAction.java b/src/main/java/it/auties/whatsapp/model/action/RecentEmojiWeightsAction.java new file mode 100644 index 000000000..918ff52f1 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/RecentEmojiWeightsAction.java @@ -0,0 +1,48 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; +import it.auties.whatsapp.model.sync.RecentEmojiWeight; + +import java.util.List; + +/** + * A model clas that represents a change in the weight of recent emojis + */ +@ProtobufMessageName("SyncActionValue.RecentEmojiWeightsAction") +public record RecentEmojiWeightsAction( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + List weights +) implements Action { + /** + * Always throws an exception as this action cannot be serialized + * + * @return an exception + */ + @Override + public String indexName() { + throw new UnsupportedOperationException("Cannot send action"); + } + + /** + * Always throws an exception as this action cannot be serialized + * + * @return an exception + */ + @Override + public int actionVersion() { + throw new UnsupportedOperationException("Cannot send action"); + } + + /** + * Always throws an exception as this action cannot be serialized + * + * @return an exception + */ + @Override + public PatchType actionType() { + throw new UnsupportedOperationException("Cannot send action"); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/RemoveRecentStickerAction.java b/src/main/java/it/auties/whatsapp/model/action/RemoveRecentStickerAction.java new file mode 100644 index 000000000..8dd204ef8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/RemoveRecentStickerAction.java @@ -0,0 +1,58 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + +/** + * A model class that represents the deletion of a sticker from the recent list + */ +@ProtobufMessageName("SyncActionValue.RemoveRecentStickerAction") +public record RemoveRecentStickerAction( + @ProtobufProperty(index = 1, type = ProtobufType.INT64) + long lastStickerSentTimestampSeconds +) implements Action { + /** + * Returns when the sticker was last sent + * + * @return an optional + */ + public Optional lastStickerSentTimestamp() { + return Clock.parseSeconds(lastStickerSentTimestampSeconds); + } + + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "removeRecentSticker"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 7; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/StarAction.java b/src/main/java/it/auties/whatsapp/model/action/StarAction.java new file mode 100644 index 000000000..99a857991 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/StarAction.java @@ -0,0 +1,45 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model clas that represents a new star status for a message + */ +@ProtobufMessageName("SyncActionValue.StarAction") +public record StarAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean starred +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "star"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 2; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/StickerAction.java b/src/main/java/it/auties/whatsapp/model/action/StickerAction.java new file mode 100644 index 000000000..fe029beca --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/StickerAction.java @@ -0,0 +1,64 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + + +/** + * A model clas that represents a sticker + */ +@ProtobufMessageName("SyncActionValue.StickerAction") +public record StickerAction( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String url, + @ProtobufProperty(index = 2, type = ProtobufType.BYTES) + byte[] fileEncSha256, + @ProtobufProperty(index = 3, type = ProtobufType.BYTES) + byte[] mediaKey, + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + String mimetype, + @ProtobufProperty(index = 5, type = ProtobufType.UINT32) + int height, + @ProtobufProperty(index = 6, type = ProtobufType.UINT32) + int width, + @ProtobufProperty(index = 7, type = ProtobufType.STRING) + String directPath, + @ProtobufProperty(index = 8, type = ProtobufType.UINT64) + long fileLength, + @ProtobufProperty(index = 9, type = ProtobufType.BOOL) + boolean favorite, + @ProtobufProperty(index = 10, type = ProtobufType.UINT32) + Integer deviceIdHint +) implements Action { + /** + * Always throws an exception as this action cannot be serialized + * + * @return an exception + */ + @Override + public String indexName() { + throw new UnsupportedOperationException("Cannot send action"); + } + + /** + * Always throws an exception as this action cannot be serialized + * + * @return an exception + */ + @Override + public int actionVersion() { + throw new UnsupportedOperationException("Cannot send action"); + } + + /** + * Always throws an exception as this action cannot be serialized + * + * @return an exception + */ + @Override + public PatchType actionType() { + throw new UnsupportedOperationException("Cannot send action"); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/SubscriptionAction.java b/src/main/java/it/auties/whatsapp/model/action/SubscriptionAction.java new file mode 100644 index 000000000..5b05375c9 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/SubscriptionAction.java @@ -0,0 +1,62 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + +/** + * A model clas that represents a subscription + */ +@ProtobufMessageName("SyncActionValue.SubscriptionAction") +public record SubscriptionAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean deactivated, + @ProtobufProperty(index = 2, type = ProtobufType.BOOL) + boolean autoRenewing, + @ProtobufProperty(index = 3, type = ProtobufType.INT64) + long expirationDateSeconds +) implements Action { + /** + * Returns when the subscription ends + * + * @return an optional + */ + public Optional expirationDate() { + return Clock.parseSeconds(expirationDateSeconds); + } + + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "subscription"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 1; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/TimeFormatAction.java b/src/main/java/it/auties/whatsapp/model/action/TimeFormatAction.java new file mode 100644 index 000000000..7d0def9c7 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/TimeFormatAction.java @@ -0,0 +1,45 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model clas that represents the time format used by the companion + */ +@ProtobufMessageName("SyncActionValue.TimeFormatAction") +public record TimeFormatAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean twentyFourHourFormatEnabled +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "time_format"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 7; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/action/UserStatusMuteAction.java b/src/main/java/it/auties/whatsapp/model/action/UserStatusMuteAction.java new file mode 100644 index 000000000..8e0a47271 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/action/UserStatusMuteAction.java @@ -0,0 +1,45 @@ +package it.auties.whatsapp.model.action; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.PatchType; + +/** + * A model clas that represents whether a user was muted + */ +@ProtobufMessageName("SyncActionValue.UserStatusMuteAction") +public record UserStatusMuteAction( + @ProtobufProperty(index = 1, type = ProtobufType.BOOL) + boolean muted +) implements Action { + /** + * The name of this action + * + * @return a non-null string + */ + @Override + public String indexName() { + return "userStatusMute"; + } + + /** + * The version of this action + * + * @return a non-null string + */ + @Override + public int actionVersion() { + return 7; + } + + /** + * The type of this action + * + * @return a non-null string + */ + @Override + public PatchType actionType() { + return null; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessAccountPayload.java b/src/main/java/it/auties/whatsapp/model/business/BusinessAccountPayload.java new file mode 100644 index 000000000..bd3e59411 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessAccountPayload.java @@ -0,0 +1,19 @@ +package it.auties.whatsapp.model.business; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that holds a payload about a business account. + */ +@ProtobufMessageName("BizAccountPayload") +public record BusinessAccountPayload( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + BusinessVerifiedNameCertificate certificate, + @ProtobufProperty(index = 2, type = ProtobufType.BYTES) + byte[] info +) implements ProtobufMessage { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessCatalogEntry.java b/src/main/java/it/auties/whatsapp/model/business/BusinessCatalogEntry.java new file mode 100644 index 000000000..332fc83c9 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessCatalogEntry.java @@ -0,0 +1,71 @@ +package it.auties.whatsapp.model.business; + +import it.auties.whatsapp.model.node.Node; + +import java.net.URI; +import java.util.NoSuchElementException; + +/** + * A record class that represents a business catalog entry. + * + * @param id the unique identifier of the catalog entry + * @param encryptedImage the encrypted URL of the original image of the catalog entry + * @param reviewStatus the review status of the catalog entry + * @param availability the availability status of the catalog entry + * @param name the name of the catalog entry + * @param sellerId the unique identifier of the seller of the catalog entry + * @param uri the URI of the catalog entry + * @param description the description of the catalog entry + * @param price the price of the catalog entry + * @param currency the currency of the price of the catalog entry + * @param hidden whether the catalog entry is hidden or not + */ +public record BusinessCatalogEntry(String id, URI encryptedImage, BusinessReviewStatus reviewStatus, + BusinessItemAvailability availability, String name, String sellerId, + URI uri, String description, long price, String currency, + boolean hidden) { + /** + * A factory method that creates a BusinessCatalogEntry object from a given Node. + * + * @param node the node to get the data from + * @return a BusinessCatalogEntry object + * @throws NoSuchElementException if some required data is missing + */ + public static BusinessCatalogEntry of(Node node) { + var id = node.attributes().getRequiredString("id"); + var hidden = node.attributes().getBoolean("is_hidden"); + var name = node.findNode("name") + .flatMap(Node::contentAsString) + .orElseThrow(() -> new NoSuchElementException("Missing name for catalog entry")); + var encryptedImage = node.findNode("media") + .flatMap(entry -> entry.findNode("original_image_url")) + .flatMap(Node::contentAsString) + .map(URI::create) + .orElseThrow(() -> new NoSuchElementException("Missing image for catalog entry")); + var statusInfo = node.findNode("status_info") + .flatMap(entry -> entry.findNode("status")) + .flatMap(Node::contentAsString) + .map(BusinessReviewStatus::of) + .orElse(BusinessReviewStatus.NO_REVIEW); + var availability = node.findNode("availability") + .flatMap(Node::contentAsString) + .map(BusinessItemAvailability::of) + .orElse(BusinessItemAvailability.UNKNOWN); + var sellerId = node.findNode("retailer_id") + .flatMap(Node::contentAsString) + .orElseThrow(() -> new NoSuchElementException("Missing seller id for catalog entry")); + var uri = node.findNode("url") + .flatMap(Node::contentAsString) + .map(URI::create) + .orElseThrow(() -> new NoSuchElementException("Missing uri for catalog entry")); + var description = node.findNode("description").flatMap(Node::contentAsString).orElse(""); + var price = node.findNode("price") + .flatMap(Node::contentAsString) + .map(Long::parseUnsignedLong) + .orElseThrow(() -> new NoSuchElementException("Missing price for catalog entry")); + var currency = node.findNode("currency") + .flatMap(Node::contentAsString) + .orElseThrow(() -> new NoSuchElementException("Missing currency for catalog entry")); + return new BusinessCatalogEntry(id, encryptedImage, statusInfo, availability, name, sellerId, uri, description, price, currency, hidden); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessCategory.java b/src/main/java/it/auties/whatsapp/model/business/BusinessCategory.java new file mode 100644 index 000000000..7b46ae062 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessCategory.java @@ -0,0 +1,34 @@ +package it.auties.whatsapp.model.business; + +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.node.Node; + +import java.net.URLDecoder; +import java.nio.charset.StandardCharsets; + +/** + * A model class that represents a business category + * + * @param id the non-null id + * @param name the non-null display name + */ +public record BusinessCategory( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String id, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String name +) implements ProtobufMessage { + /** + * Constructs a category from a node + * + * @param node a non-null node + * @return a non-null category + */ + public static BusinessCategory of(Node node) { + var id = node.attributes().getRequiredString("id"); + var name = URLDecoder.decode(node.contentAsString().orElseThrow(), StandardCharsets.UTF_8); + return new BusinessCategory(id, name); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessCollectionEntry.java b/src/main/java/it/auties/whatsapp/model/business/BusinessCollectionEntry.java new file mode 100644 index 000000000..ed32e08e7 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessCollectionEntry.java @@ -0,0 +1,35 @@ +package it.auties.whatsapp.model.business; + +import it.auties.whatsapp.model.node.Node; + +import java.util.List; +import java.util.NoSuchElementException; + +/** + * Record class representing a business collection entry. + * + * @param id the id of the business collection + * @param name the name of the business collection + * @param products the list of products in the business collection + */ +public record BusinessCollectionEntry(String id, String name, + List products) { + /** + * Creates a {@code BusinessCollectionEntry} object from a {@code Node} object. + * + * @param node the node representing the business collection entry + * @return the created {@code BusinessCollectionEntry} object + * @throws NoSuchElementException if the id or name of the business collection is missing from the + * node + */ + public static BusinessCollectionEntry of(Node node) { + var id = node.findNode("id") + .flatMap(Node::contentAsString) + .orElseThrow(() -> new NoSuchElementException("Missing id from business collections")); + var name = node.findNode("name") + .flatMap(Node::contentAsString) + .orElseThrow(() -> new NoSuchElementException("Missing name from business collections")); + var products = node.findNodes("product").stream().map(BusinessCatalogEntry::of).toList(); + return new BusinessCollectionEntry(id, name, products); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessHours.java b/src/main/java/it/auties/whatsapp/model/business/BusinessHours.java new file mode 100644 index 000000000..b584f0828 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessHours.java @@ -0,0 +1,16 @@ +package it.auties.whatsapp.model.business; + + +import java.util.List; + +/** + * A business hours representation that contains the business' time zone and a list of business hour + * entries. + * + * @param timeZone The time zone of the business. + * @param entries A list of business hours entries that contains information about the hours of + * operation for each day of the week. + */ +public record BusinessHours(String timeZone, List entries) { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessHoursEntry.java b/src/main/java/it/auties/whatsapp/model/business/BusinessHoursEntry.java new file mode 100644 index 000000000..883869713 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessHoursEntry.java @@ -0,0 +1,37 @@ +package it.auties.whatsapp.model.business; + +import it.auties.whatsapp.model.node.Node; + +/** + * A business hours entry that represents the hours of operation for a single day of the week. + * + * @param day The day of the week that this entry represents. + * @param mode The mode of operation for this day. + * @param openTime The time in seconds since midnight that the business opens. + * @param closeTime The time in seconds since midnight that the business closes. + */ +public record BusinessHoursEntry(String day, String mode, long openTime, long closeTime) { + /** + * Creates a {@link BusinessHoursEntry} from a {@link Node}. + * + * @param node The node to extract the business hours entry information from. + * @return A {@link BusinessHoursEntry} extracted from the provided node. + */ + public static BusinessHoursEntry of(Node node) { + return new BusinessHoursEntry( + node.attributes().getString("day_of_week"), + node.attributes().getString("mode"), + node.attributes().getLong("open_time"), + node.attributes().getLong("close_time") + ); + } + + /** + * Returns whether the business is always open. + * + * @return whether the business is always open + */ + public boolean isAlwaysOpen() { + return openTime == 0 && closeTime == 0; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessItemAvailability.java b/src/main/java/it/auties/whatsapp/model/business/BusinessItemAvailability.java new file mode 100644 index 000000000..129e4e07b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessItemAvailability.java @@ -0,0 +1,35 @@ +package it.auties.whatsapp.model.business; + +import java.util.Arrays; +import java.util.Locale; + +/** + * An enumeration of possible Availabilities. + */ +public enum BusinessItemAvailability { + /** + * Indicates an unknown availability. + */ + UNKNOWN, + /** + * Indicates that the item is in stock. + */ + IN_STOCK, + /** + * Indicates that the item is out of stock. + */ + OUT_OF_STOCK; + + /** + * Returns an Availability based on the given name. + * + * @param name the name of the Availability + * @return an Availability + */ + public static BusinessItemAvailability of(String name) { + return Arrays.stream(values()) + .filter(entry -> entry.name().toLowerCase(Locale.ROOT).replaceAll("_", " ").equals(name)) + .findFirst() + .orElse(UNKNOWN); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessLocalizedName.java b/src/main/java/it/auties/whatsapp/model/business/BusinessLocalizedName.java new file mode 100644 index 000000000..3d4b068c5 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessLocalizedName.java @@ -0,0 +1,18 @@ +package it.auties.whatsapp.model.business; + +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents a time a localizable name + */ +public record BusinessLocalizedName( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String lg, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String lc, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + String name +) implements ProtobufMessage { +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessPrivacyStatus.java b/src/main/java/it/auties/whatsapp/model/business/BusinessPrivacyStatus.java new file mode 100644 index 000000000..5aa07be3a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessPrivacyStatus.java @@ -0,0 +1,36 @@ +package it.auties.whatsapp.model.business; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; + +/** + * The constants of this enumerated type describe the various types of business privacy + */ +public enum BusinessPrivacyStatus implements ProtobufEnum { + /** + * End-to-end encryption + */ + E2EE(0), + /** + * Bsp encryption + */ + BSP(1), + /** + * Facebook encryption + */ + FACEBOOK(2), + /** + * Facebook and bsp encryption + */ + BSP_AND_FB(3); + + final int index; + + BusinessPrivacyStatus(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessProfile.java b/src/main/java/it/auties/whatsapp/model/business/BusinessProfile.java new file mode 100644 index 000000000..e9e2150b7 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessProfile.java @@ -0,0 +1,75 @@ +package it.auties.whatsapp.model.business; + +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.node.Node; + +import java.net.URI; +import java.util.Collection; +import java.util.List; +import java.util.Optional; + +/** + * This model class represents the metadata of a business profile + */ +public record BusinessProfile( + Jid jid, + Optional description, + Optional address, + Optional email, + Optional hours, + boolean cartEnabled, + List websites, + List categories +) { + /** + * Constructs a new profile from a node + * + * @param node a non-null node + * @return a non-null profile + */ + public static BusinessProfile of(Node node) { + var jid = node.attributes() + .getRequiredJid("jid"); + var address = node.findNode("address") + .flatMap(Node::contentAsString); + var description = node.findNode("description") + .flatMap(Node::contentAsString); + var websites = node.findNodes("website") + .stream() + .map(Node::contentAsString) + .flatMap(Optional::stream) + .map(URI::create) + .toList(); + var email = node.findNode("email") + .flatMap(Node::contentAsString); + var categories = node.findNodes("categories") + .stream() + .map(entry -> entry.findNode("category")) + .flatMap(Optional::stream) + .map(BusinessCategory::of) + .toList(); + var commerceExperience = node.findNode("profile_options"); + var cartEnabled = commerceExperience.flatMap(entry -> entry.findNode("cart_enabled")) + .flatMap(Node::contentAsBoolean) + .orElse(commerceExperience.isEmpty()); + var hours = createHours(node); + return new BusinessProfile(jid, description, address, email, hours, cartEnabled, websites, categories); + } + + private static Optional createHours(Node node) { + var timezone = node.findNode("business_hours") + .map(Node::attributes) + .map(attributes -> attributes.getNullableString("timezone")); + if (timezone.isEmpty()) { + return Optional.empty(); + } + + var entries = node.findNode("business_hours") + .stream() + .map(entry -> entry.findNodes("business_hours_config")) + .flatMap(Collection::stream) + .map(BusinessHoursEntry::of) + .toList(); + return Optional.of(new BusinessHours(timezone.get(), entries)); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessReviewStatus.java b/src/main/java/it/auties/whatsapp/model/business/BusinessReviewStatus.java new file mode 100644 index 000000000..bedd75874 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessReviewStatus.java @@ -0,0 +1,39 @@ +package it.auties.whatsapp.model.business; + +import java.util.Locale; + +/** + * An enumeration of possible ReviewStatuses. + */ +public enum BusinessReviewStatus { + /** + * Indicates that no review has been performed. + */ + NO_REVIEW, + /** + * Indicates that the review is pending. + */ + PENDING, + /** + * Indicates that the review was rejected. + */ + REJECTED, + /** + * Indicates that the review was approved. + */ + APPROVED, + /** + * Indicates that the review is outdated. + */ + OUTDATED; + + /** + * Returns a ReviewStatus based on the given name. + * + * @param name the name of the ReviewStatus + * @return a ReviewStatus + */ + public static BusinessReviewStatus of(String name) { + return valueOf(name.toUpperCase(Locale.ROOT)); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessVerifiedNameCertificate.java b/src/main/java/it/auties/whatsapp/model/business/BusinessVerifiedNameCertificate.java new file mode 100644 index 000000000..8343e251e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessVerifiedNameCertificate.java @@ -0,0 +1,23 @@ +package it.auties.whatsapp.model.business; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents a business certificate + */ +@ProtobufMessageName("VerifiedNameCertificate") +public record BusinessVerifiedNameCertificate( + @ProtobufProperty(index = 1, type = ProtobufType.BYTES) + byte[] encodedDetails, + @ProtobufProperty(index = 2, type = ProtobufType.BYTES) + byte[] signature, + @ProtobufProperty(index = 3, type = ProtobufType.BYTES) + byte[] serverSignature +) implements ProtobufMessage { + public BusinessVerifiedNameDetails details() { + return BusinessVerifiedNameDetailsSpec.decode(encodedDetails); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/business/BusinessVerifiedNameDetails.java b/src/main/java/it/auties/whatsapp/model/business/BusinessVerifiedNameDetails.java new file mode 100644 index 000000000..5720447c4 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/business/BusinessVerifiedNameDetails.java @@ -0,0 +1,38 @@ +package it.auties.whatsapp.model.business; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.List; +import java.util.Optional; + + +/** + * A model class that represents a verified name + */ +@ProtobufMessageName("VerifiedNameCertificate.Details") +public record BusinessVerifiedNameDetails( + @ProtobufProperty(index = 1, type = ProtobufType.UINT64) + long serial, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String issuer, + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + String name, + @ProtobufProperty(index = 8, type = ProtobufType.OBJECT) + List localizedNames, + @ProtobufProperty(index = 10, type = ProtobufType.UINT64) + long issueTimeSeconds +) implements ProtobufMessage { + /** + * Returns this object's timestampSeconds + * + * @return an optional + */ + public Optional issueTime() { + return Clock.parseSeconds(issueTimeSeconds); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/base/Button.java b/src/main/java/it/auties/whatsapp/model/button/base/Button.java new file mode 100644 index 000000000..8f2a4ca02 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/base/Button.java @@ -0,0 +1,66 @@ +package it.auties.whatsapp.model.button.base; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.base.ButtonBody.Type; +import it.auties.whatsapp.model.info.NativeFlowInfo; +import it.auties.whatsapp.util.Bytes; + +import java.util.HexFormat; +import java.util.Optional; + +/** + * A model class that represents a button + */ +@ProtobufMessageName("Message.ButtonsMessage.Button") +public record Button( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String id, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Optional bodyText, + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + Optional bodyNativeFlow, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + Type bodyType +) implements ProtobufMessage { + /** + * Constructs a new button + * + * @param body the body of this button + * @return a non-null button + */ + public static Button of(ButtonBody body) { + var id = HexFormat.of().formatHex(Bytes.random(6)); + return Button.of(id, body); + } + + /** + * Constructs a new button + * + * @param id the non-null id of the button + * @param body the body of this button + * @return a non-null button + */ + public static Button of(String id, ButtonBody body) { + var builder = new ButtonBuilder() + .id(id); + switch (body) { + case ButtonText buttonText -> builder.bodyText(buttonText).bodyType(Type.TEXT); + case NativeFlowInfo flowInfo -> builder.bodyNativeFlow(flowInfo).bodyType(Type.NATIVE_FLOW); + case null -> builder.bodyType(Type.UNKNOWN); + } + return builder.build(); + } + + /** + * Returns the body of this button + * + * @return an optional + */ + public Optional body() { + return bodyText.isPresent() ? bodyText : bodyNativeFlow; + } + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/base/ButtonActionLink.java b/src/main/java/it/auties/whatsapp/model/button/base/ButtonActionLink.java new file mode 100644 index 000000000..3f2e0d727 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/base/ButtonActionLink.java @@ -0,0 +1,19 @@ +package it.auties.whatsapp.model.button.base; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +/** + * An action link for a button + */ +@ProtobufMessageName("ActionLink") +public record ButtonActionLink( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String url, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String buttonTitle +) implements ProtobufMessage { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/base/ButtonBody.java b/src/main/java/it/auties/whatsapp/model/button/base/ButtonBody.java new file mode 100644 index 000000000..3262ab52f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/base/ButtonBody.java @@ -0,0 +1,34 @@ +package it.auties.whatsapp.model.button.base; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.whatsapp.model.info.NativeFlowInfo; + +/** + * A model that represents the body of a button + */ +public sealed interface ButtonBody extends ProtobufMessage permits ButtonText, NativeFlowInfo { + /** + * Returns the type of this body + * + * @return a non-null type + */ + Type bodyType(); + + enum Type implements ProtobufEnum { + UNKNOWN(0), + TEXT(1), + NATIVE_FLOW(2); + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/base/ButtonText.java b/src/main/java/it/auties/whatsapp/model/button/base/ButtonText.java new file mode 100644 index 000000000..3d5347fad --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/base/ButtonText.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.model.button.base; + +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents the text of a button + */ +public record ButtonText( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String content +) implements ButtonBody { + @Override + public Type bodyType() { + return Type.TEXT; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveBody.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveBody.java new file mode 100644 index 000000000..254e87607 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveBody.java @@ -0,0 +1,22 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents the body of a product + */ +@ProtobufMessageName("Message.InteractiveMessage.Body") +public record InteractiveBody( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String content +) implements ProtobufMessage { + public static Optional ofNullable(String content) { + return Optional.ofNullable(content) + .map(InteractiveBody::new); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveButton.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveButton.java new file mode 100644 index 000000000..8504b59d8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveButton.java @@ -0,0 +1,23 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents a native flow button + */ +@ProtobufMessageName("Message.InteractiveMessage.NativeFlowMessage.NativeFlowButton") +public record InteractiveButton( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String name, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + Optional parameters +) implements ProtobufMessage { + public InteractiveButton(String name) { + this(name, Optional.empty()); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveCollection.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveCollection.java new file mode 100644 index 000000000..87ebfdc25 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveCollection.java @@ -0,0 +1,27 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.message.button.InteractiveMessageContent; + +/** + * A model class that represents a business collection + */ +@ProtobufMessageName("Message.InteractiveMessage.CollectionMessage") +public record InteractiveCollection( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Jid business, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String id, + @ProtobufProperty(index = 3, type = ProtobufType.INT32) + int version +) implements InteractiveMessageContent { + + + @Override + public Type contentType() { + return Type.COLLECTION; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveFooter.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveFooter.java new file mode 100644 index 000000000..862d56e27 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveFooter.java @@ -0,0 +1,23 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents the footer of a product + */ +@ProtobufMessageName("Message.InteractiveMessage.Footer") +public record InteractiveFooter( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String content +) implements ProtobufMessage { + + public static Optional ofNullable(String content) { + return Optional.ofNullable(content) + .map(InteractiveFooter::new); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeader.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeader.java new file mode 100644 index 000000000..37d853791 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeader.java @@ -0,0 +1,84 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufBuilder; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.message.standard.DocumentMessage; +import it.auties.whatsapp.model.message.standard.ImageMessage; +import it.auties.whatsapp.model.message.standard.VideoOrGifMessage; + +import java.util.Optional; + + +/** + * A model class that represents the header of a product + */ +@ProtobufMessageName("Message.InteractiveMessage.Header") +public record InteractiveHeader( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String title, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + Optional subtitle, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + Optional attachmentDocument, + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + Optional attachmentImage, + @ProtobufProperty(index = 5, type = ProtobufType.BOOL) + boolean mediaAttachment, + @ProtobufProperty(index = 6, type = ProtobufType.BYTES) + Optional attachmentThumbnail, + @ProtobufProperty(index = 7, type = ProtobufType.OBJECT) + Optional attachmentVideo +) implements ProtobufMessage { + @ProtobufBuilder(className = "InteractiveHeaderSimpleBuilder") + static InteractiveHeader simpleBuilder(String title, String subtitle, InteractiveHeaderAttachment attachment) { + var builder = new InteractiveHeaderBuilder() + .title(title) + .subtitle(subtitle); + switch (attachment) { + case DocumentMessage documentMessage -> builder.attachmentDocument(documentMessage); + case ImageMessage imageMessage -> builder.attachmentImage(imageMessage); + case InteractiveHeaderThumbnail productHeaderThumbnail -> + builder.attachmentThumbnail(productHeaderThumbnail); + case VideoOrGifMessage videoMessage -> builder.attachmentVideo(videoMessage); + case null -> { + } + } + builder.mediaAttachment(attachment != null); + return builder.build(); + } + + /** + * Returns the type of attachment of this message + * + * @return a non-null attachment type + */ + public InteractiveHeaderAttachment.Type attachmentType() { + return attachment() + .map(InteractiveHeaderAttachment::interactiveHeaderType) + .orElse(InteractiveHeaderAttachment.Type.NONE); + } + + /** + * Returns the attachment of this message if present + * + * @return a non-null attachment type + */ + public Optional attachment() { + if (attachmentDocument.isPresent()) { + return attachmentDocument; + } + + if (attachmentImage.isPresent()) { + return attachmentImage; + } + + if (attachmentThumbnail.isPresent()) { + return attachmentThumbnail; + } + + return attachmentVideo; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeaderAttachment.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeaderAttachment.java new file mode 100644 index 000000000..703db8df5 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeaderAttachment.java @@ -0,0 +1,51 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.whatsapp.model.message.standard.DocumentMessage; +import it.auties.whatsapp.model.message.standard.ImageMessage; +import it.auties.whatsapp.model.message.standard.VideoOrGifMessage; + +/** + * A sealed class that describes the various types of headers + */ +public sealed interface InteractiveHeaderAttachment permits DocumentMessage, ImageMessage, InteractiveHeaderThumbnail, VideoOrGifMessage { + Type interactiveHeaderType(); + + /** + * The constants of this enumerated type describe the various types of attachment that a product + * header can have + */ + enum Type implements ProtobufEnum { + /** + * No attachment + */ + NONE(0), + /** + * Document message + */ + DOCUMENT(3), + /** + * Image attachment + */ + IMAGE(4), + /** + * Jpeg attachment + */ + THUMBNAIL(6), + /** + * Video attachment + */ + VIDEO(7); + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeaderThumbnail.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeaderThumbnail.java new file mode 100644 index 000000000..9064d1695 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveHeaderThumbnail.java @@ -0,0 +1,26 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufConverter; + +/** + * A model that represents the jpeg thumbnail of a {@link InteractiveHeader} + * + * @param thumbnail the non-null jpeg thumbnail + */ +public record InteractiveHeaderThumbnail(byte[] thumbnail) implements InteractiveHeaderAttachment { + @ProtobufConverter + public static InteractiveHeaderThumbnail of(byte[] thumbnail) { + return new InteractiveHeaderThumbnail(thumbnail); + } + + @ProtobufConverter + @Override + public byte[] thumbnail() { + return thumbnail; + } + + @Override + public Type interactiveHeaderType() { + return Type.THUMBNAIL; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveLocationAnnotation.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveLocationAnnotation.java new file mode 100644 index 000000000..935a9d1d1 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveLocationAnnotation.java @@ -0,0 +1,55 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.List; + +/** + * A model class that describes an interactive annotation linked to a message + */ +@ProtobufMessageName("InteractiveAnnotation") +public record InteractiveLocationAnnotation( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + List polygonVertices, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + InterativeLocation location +) implements ProtobufMessage { + /** + * Returns the type of sync + * + * @return a non-null Action + */ + public Action type() { + return location != null ? Action.LOCATION : Action.UNKNOWN; + } + + /** + * The constants of this enumerated type describe the various types of sync that an interactive + * annotation can provide + */ + public enum Action implements ProtobufEnum { + /** + * Unknown + */ + UNKNOWN(0), + /** + * Location + */ + LOCATION(2); + + final int index; + + Action(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveNativeFlow.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveNativeFlow.java new file mode 100644 index 000000000..4ff9296a6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveNativeFlow.java @@ -0,0 +1,28 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.message.button.InteractiveMessageContent; + +import java.util.List; + + +/** + * A model class that represents a native flow + * Here> is an explanation on how to use this kind of message + */ +@ProtobufMessageName("Message.InteractiveMessage.NativeFlowMessage") +public record InteractiveNativeFlow( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + List buttons, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String parameters, + @ProtobufProperty(index = 3, type = ProtobufType.INT32) + int version +) implements InteractiveMessageContent { + @Override + public Type contentType() { + return Type.NATIVE_FLOW; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractivePoint.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractivePoint.java new file mode 100644 index 000000000..accd9f006 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractivePoint.java @@ -0,0 +1,25 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +/** + * This model class describes a Point in space + */ +@ProtobufMessageName("Point") +public record InteractivePoint( + @ProtobufProperty(index = 1, type = ProtobufType.INT32) + @Deprecated + int xDeprecated, + @ProtobufProperty(index = 2, type = ProtobufType.INT32) + @Deprecated + int yDeprecated, + @ProtobufProperty(index = 3, type = ProtobufType.DOUBLE) + double x, + @ProtobufProperty(index = 4, type = ProtobufType.DOUBLE) + double y +) implements ProtobufMessage { + +} diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveResponseBody.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveResponseBody.java new file mode 100644 index 000000000..b1f81d65f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveResponseBody.java @@ -0,0 +1,22 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents the body of a product + */ +@ProtobufMessageName("Message.InteractiveResponseMessage.Body") +public record InteractiveResponseBody( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String content +) implements ProtobufMessage { + public static Optional ofNullable(String content) { + return Optional.ofNullable(content) + .map(InteractiveResponseBody::new); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveShop.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveShop.java new file mode 100644 index 000000000..bac46fb0f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InteractiveShop.java @@ -0,0 +1,61 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.message.button.InteractiveMessageContent; + + +/** + * A model class that represents a shop + */ +@ProtobufMessageName("Message.InteractiveMessage.ShopMessage") +public record InteractiveShop( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String id, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + SurfaceType surfaceType, + @ProtobufProperty(index = 3, type = ProtobufType.INT32) + int version +) implements InteractiveMessageContent { + @Override + public Type contentType() { + return Type.SHOP; + } + + /** + * The constants of this enumerated type describe the various types of surfaces that a + * {@link InteractiveShop} can have + */ + @ProtobufMessageName("Message.InteractiveMessage.ShopMessage.Surface") + public enum SurfaceType implements ProtobufEnum { + /** + * Unknown + */ + UNKNOWN_SURFACE(0), + /** + * Facebook + */ + FACEBOOK(1), + /** + * Instagram + */ + INSTAGRAM(2), + /** + * Whatsapp + */ + WHATSAPP(3); + + final int index; + + SurfaceType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/interactive/InterativeLocation.java b/src/main/java/it/auties/whatsapp/model/button/interactive/InterativeLocation.java new file mode 100644 index 000000000..f9516393a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/interactive/InterativeLocation.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.model.button.interactive; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +/** + * This model class describes a Location + */ +@ProtobufMessageName("Location") +public record InterativeLocation( + @ProtobufProperty(index = 1, type = ProtobufType.DOUBLE) + double latitude, + @ProtobufProperty(index = 2, type = ProtobufType.DOUBLE) + double longitude, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + String name +) implements ProtobufMessage { + +} diff --git a/src/main/java/it/auties/whatsapp/model/button/misc/ButtonOpaqueData.java b/src/main/java/it/auties/whatsapp/model/button/misc/ButtonOpaqueData.java new file mode 100644 index 000000000..5194eee08 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/misc/ButtonOpaqueData.java @@ -0,0 +1,71 @@ +package it.auties.whatsapp.model.button.misc; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.poll.PollOption; +import it.auties.whatsapp.model.poll.PollUpdateEncryptedMetadata; + +import java.util.List; +import java.util.Optional; + + +/** + * A model class that represents data about a button + */ +@ProtobufMessageName("MsgOpaqueData") +public record ButtonOpaqueData( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Optional body, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + Optional caption, + @ProtobufProperty(index = 5, type = ProtobufType.DOUBLE) + double longitude, + @ProtobufProperty(index = 7, type = ProtobufType.DOUBLE) + double latitude, + @ProtobufProperty(index = 8, type = ProtobufType.INT32) + int paymentAmount1000, + @ProtobufProperty(index = 9, type = ProtobufType.STRING) + Optional paymentNote, + @ProtobufProperty(index = 10, type = ProtobufType.STRING) + Optional canonicalUrl, + @ProtobufProperty(index = 11, type = ProtobufType.STRING) + Optional matchedText, + @ProtobufProperty(index = 12, type = ProtobufType.STRING) + Optional title, + @ProtobufProperty(index = 13, type = ProtobufType.STRING) + Optional description, + @ProtobufProperty(index = 6, type = ProtobufType.BOOL) + boolean isLive, + @ProtobufProperty(index = 14, type = ProtobufType.BYTES) + Optional futureProofBuffer, + @ProtobufProperty(index = 15, type = ProtobufType.STRING) + Optional clientUrl, + @ProtobufProperty(index = 16, type = ProtobufType.STRING) + Optional loc, + @ProtobufProperty(index = 17, type = ProtobufType.STRING) + Optional pollName, + @ProtobufProperty(index = 18, type = ProtobufType.OBJECT) + List pollOptions, + @ProtobufProperty(index = 20, type = ProtobufType.UINT32) + int pollSelectableOptionsCount, + @ProtobufProperty(index = 21, type = ProtobufType.BYTES) + Optional messageSecret, + @ProtobufProperty(index = 51, type = ProtobufType.STRING) + Optional originalSelfAuthor, + @ProtobufProperty(index = 22, type = ProtobufType.INT64) + long senderTimestampMs, + @ProtobufProperty(index = 23, type = ProtobufType.STRING) + Optional pollUpdateParentKey, + @ProtobufProperty(index = 24, type = ProtobufType.OBJECT) + Optional encPollVote, + @ProtobufProperty(index = 25, type = ProtobufType.STRING) + Optional encReactionTargetMessageKey, + @ProtobufProperty(index = 26, type = ProtobufType.BYTES) + Optional encReactionEncPayload, + @ProtobufProperty(index = 27, type = ProtobufType.BYTES) + Optional encReactionEncIv +) implements ProtobufMessage { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/misc/ButtonRow.java b/src/main/java/it/auties/whatsapp/model/button/misc/ButtonRow.java new file mode 100644 index 000000000..064451fed --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/misc/ButtonRow.java @@ -0,0 +1,26 @@ +package it.auties.whatsapp.model.button.misc; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.util.Bytes; + +import java.util.HexFormat; + +/** + * A model class that represents a row of buttons + */ +@ProtobufMessageName("Message.ListMessage.Row") +public record ButtonRow( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String title, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String description, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + String id +) implements ProtobufMessage { + public static ButtonRow of(String title, String description) { + return new ButtonRow(title, description, HexFormat.of().formatHex(Bytes.random(5))); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/misc/ButtonRowOpaqueData.java b/src/main/java/it/auties/whatsapp/model/button/misc/ButtonRowOpaqueData.java new file mode 100644 index 000000000..70ea6c85d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/misc/ButtonRowOpaqueData.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.model.button.misc; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents data about a row + */ +@ProtobufMessageName("MsgRowOpaqueData") +public record ButtonRowOpaqueData( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Optional currentMessage, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Optional quotedMessage +) implements ProtobufMessage { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/misc/ButtonSection.java b/src/main/java/it/auties/whatsapp/model/button/misc/ButtonSection.java new file mode 100644 index 000000000..f783d710d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/misc/ButtonSection.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.model.button.misc; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.List; + +/** + * A model class that represents a section of buttons + */ +@ProtobufMessageName("Message.ListMessage.Section") +public record ButtonSection( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String title, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + List rows +) implements ProtobufMessage { + +} diff --git a/src/main/java/it/auties/whatsapp/model/button/misc/SingleSelectReplyButton.java b/src/main/java/it/auties/whatsapp/model/button/misc/SingleSelectReplyButton.java new file mode 100644 index 000000000..2d705957f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/misc/SingleSelectReplyButton.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.model.button.misc; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents the selection of a row + */ +@ProtobufMessageName("Message.ListResponseMessage.SingleSelectReply") +public record SingleSelectReplyButton( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String rowId +) implements ProtobufMessage { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/TemplateFormatter.java b/src/main/java/it/auties/whatsapp/model/button/template/TemplateFormatter.java new file mode 100644 index 000000000..7e7eb646e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/TemplateFormatter.java @@ -0,0 +1,54 @@ +package it.auties.whatsapp.model.button.template; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.whatsapp.model.button.template.hsm.HighlyStructuredFourRowTemplate; +import it.auties.whatsapp.model.button.template.hydrated.HydratedFourRowTemplate; +import it.auties.whatsapp.model.message.button.InteractiveMessage; +import it.auties.whatsapp.model.message.button.TemplateMessage; + +/** + * A formatter used to structure a button message + */ +public sealed interface TemplateFormatter extends ProtobufMessage permits HighlyStructuredFourRowTemplate, HydratedFourRowTemplate, InteractiveMessage { + /** + * Returns the type of this formatter + * + * @return a non-null type + */ + Type templateType(); + + /** + * The constant of this enumerated type define the various of types of visual formats for a + * {@link TemplateMessage} + */ + enum Type implements ProtobufEnum { + /** + * No format + */ + NONE(0), + /** + * Four row template + */ + FOUR_ROW(1), + /** + * Hydrated four row template + */ + HYDRATED_FOUR_ROW(2), + /** + * Interactive message + */ + INTERACTIVE(3); + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return this.index; + } + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredCurrency.java b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredCurrency.java new file mode 100644 index 000000000..58b5972d3 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredCurrency.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.model.button.template.highlyStructured; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents a currency + */ +@ProtobufMessageName("Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMCurrency") +public record HighlyStructuredCurrency( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String currencyCode, + @ProtobufProperty(index = 2, type = ProtobufType.INT64) + long amount1000 +) implements HighlyStructuredLocalizableParameterValue { + @Override + public HighlyStructuredLocalizableParameterValue.Type parameterType() { + return HighlyStructuredLocalizableParameterValue.Type.CURRENCY; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTime.java b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTime.java new file mode 100644 index 000000000..1e36c9cd0 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTime.java @@ -0,0 +1,58 @@ +package it.auties.whatsapp.model.button.template.highlyStructured; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents a time + */ +@ProtobufMessageName("Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMDateTime") +public record HighlyStructuredDateTime( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Optional dateComponent, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Optional dateUnixEpoch +) implements HighlyStructuredLocalizableParameterValue { + /** + * Constructs a new date time using a component + * + * @param dateComponent the non-null component + * @return a non-null date time + */ + public static HighlyStructuredDateTime of(HighlyStructuredDateTimeValue dateComponent) { + if (dateComponent instanceof HighlyStructuredDateTimeComponent highlyStructuredDateTimeComponent) { + return new HighlyStructuredDateTime(Optional.of(highlyStructuredDateTimeComponent), Optional.empty()); + } else if (dateComponent instanceof HighlyStructuredDateTimeUnixEpoch highlyStructuredDateTimeUnixEpoch) { + return new HighlyStructuredDateTime(Optional.empty(), Optional.of(highlyStructuredDateTimeUnixEpoch)); + } else { + return new HighlyStructuredDateTime(Optional.empty(), Optional.empty()); + } + } + + /** + * Returns the type of date of this component + * + * @return a non-null date type + */ + public HighlyStructuredDateTimeValue.Type dateType() { + return date().map(HighlyStructuredDateTimeValue::dateType) + .orElse(HighlyStructuredDateTimeValue.Type.NONE); + } + + /** + * Returns the date of this component + * + * @return a non-null date type + */ + public Optional date() { + return dateComponent.isPresent() ? dateComponent : dateUnixEpoch; + } + + @Override + public HighlyStructuredLocalizableParameterValue.Type parameterType() { + return HighlyStructuredLocalizableParameterValue.Type.DATE_TIME; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeComponent.java b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeComponent.java new file mode 100644 index 000000000..2647325dc --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeComponent.java @@ -0,0 +1,103 @@ +package it.auties.whatsapp.model.button.template.highlyStructured; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents a time component + */ +@ProtobufMessageName("Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMDateTime.HSMDateTimeComponent") +public record HighlyStructuredDateTimeComponent( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + DayOfWeek dayOfWeek, + @ProtobufProperty(index = 2, type = ProtobufType.UINT32) + int year, + @ProtobufProperty(index = 3, type = ProtobufType.UINT32) + int month, + @ProtobufProperty(index = 4, type = ProtobufType.UINT32) + int dayOfMonth, + @ProtobufProperty(index = 5, type = ProtobufType.UINT32) + int hour, + @ProtobufProperty(index = 6, type = ProtobufType.UINT32) + int minute, + @ProtobufProperty(index = 7, type = ProtobufType.OBJECT) + CalendarType calendar +) implements HighlyStructuredDateTimeValue { + @Override + public HighlyStructuredDateTimeValue.Type dateType() { + return HighlyStructuredDateTimeValue.Type.COMPONENT; + } + + /** + * The constants of this enumerated type describe the supported calendar types + */ + @ProtobufMessageName("Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMDateTime.HSMDateTimeComponent.CalendarType") + public enum CalendarType implements ProtobufEnum { + /** + * Gregorian calendar + */ + GREGORIAN(1), + /** + * Solar calendar + */ + SOLAR_HIJRI(2); + + final int index; + + CalendarType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } + + /** + * The constants of this enumerated type describe the days of the week + */ + @ProtobufMessageName("Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMDateTime.HSMDateTimeComponent.DayOfWeekType") + public enum DayOfWeek implements ProtobufEnum { + /** + * Monday + */ + MONDAY(1), + /** + * Tuesday + */ + TUESDAY(2), + /** + * Wednesday + */ + WEDNESDAY(3), + /** + * Thursday + */ + THURSDAY(4), + /** + * Friday + */ + FRIDAY(5), + /** + * Saturday + */ + SATURDAY(6), + /** + * Sunday + */ + SUNDAY(7); + + final int index; + + DayOfWeek(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeUnixEpoch.java b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeUnixEpoch.java new file mode 100644 index 000000000..dd22ee7cb --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeUnixEpoch.java @@ -0,0 +1,33 @@ +package it.auties.whatsapp.model.button.template.highlyStructured; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + +/** + * A model class that represents a time as a unix epoch + */ +@ProtobufMessageName("Message.HighlyStructuredMessage.HSMLocalizableParameter.HSMDateTime.HSMDateTimeUnixEpoch") +public record HighlyStructuredDateTimeUnixEpoch( + @ProtobufProperty(index = 1, type = ProtobufType.INT64) + long timestampSeconds +) implements HighlyStructuredDateTimeValue { + + /** + * Returns the timestampSeconds as a zoned date time + * + * @return an optional + */ + public Optional timestamp() { + return Clock.parseSeconds(timestampSeconds); + } + + @Override + public HighlyStructuredDateTimeValue.Type dateType() { + return HighlyStructuredDateTimeValue.Type.UNIX_EPOCH; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeValue.java b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeValue.java new file mode 100644 index 000000000..948ccc59d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredDateTimeValue.java @@ -0,0 +1,47 @@ +package it.auties.whatsapp.model.button.template.highlyStructured; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; + +/** + * A model class that represents the value of a localizable parameter + */ +public sealed interface HighlyStructuredDateTimeValue extends ProtobufMessage permits HighlyStructuredDateTimeComponent, HighlyStructuredDateTimeUnixEpoch { + /** + * Returns the type of date + * + * @return a non-null type + */ + Type dateType(); + + + /** + * The constants of this enumerated type describe the various type of date types that a date time can wrap + */ + enum Type implements ProtobufEnum { + /** + * No date + */ + NONE(0), + /** + * Component date + */ + COMPONENT(1), + /** + * Unix epoch date + */ + UNIX_EPOCH(2); + + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredLocalizableParameter.java b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredLocalizableParameter.java new file mode 100644 index 000000000..52429099f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredLocalizableParameter.java @@ -0,0 +1,61 @@ +package it.auties.whatsapp.model.button.template.highlyStructured; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents a time a localizable parameter + */ +@ProtobufMessageName("Message.HighlyStructuredMessage.HSMLocalizableParameter") +public record HighlyStructuredLocalizableParameter( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String defaultValue, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Optional parameterCurrency, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + Optional parameterDateTime +) implements ProtobufMessage { + /** + * Constructs a new localizable parameter with a default value and a parameter + * + * @param defaultValue the default value + * @param parameter the parameter + * @return a non-null localizable parameter + */ + public static HighlyStructuredLocalizableParameter of(String defaultValue, HighlyStructuredLocalizableParameterValue parameter) { + var builder = new HighlyStructuredLocalizableParameterBuilder() + .defaultValue(defaultValue); + switch (parameter) { + case HighlyStructuredCurrency highlyStructuredCurrency -> + builder.parameterCurrency(highlyStructuredCurrency); + case HighlyStructuredDateTime businessDateTime -> builder.parameterDateTime(businessDateTime); + case null -> { + } + } + return builder.build(); + } + + /** + * Returns the type of parameter that this message wraps + * + * @return a non-null parameter type + */ + public HighlyStructuredLocalizableParameterValue.Type parameterType() { + return parameter() + .map(HighlyStructuredLocalizableParameterValue::parameterType) + .orElse(HighlyStructuredLocalizableParameterValue.Type.NONE); + } + + /** + * Returns the parameter that this message wraps + * + * @return a non-null optional + */ + public Optional parameter() { + return parameterCurrency.isPresent() ? parameterCurrency : parameterDateTime; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredLocalizableParameterValue.java b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredLocalizableParameterValue.java new file mode 100644 index 000000000..f6ce2d48f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredLocalizableParameterValue.java @@ -0,0 +1,42 @@ +package it.auties.whatsapp.model.button.template.highlyStructured; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; + +/** + * A model class that represents the value of a localizable parameter + */ +public sealed interface HighlyStructuredLocalizableParameterValue extends ProtobufMessage permits HighlyStructuredCurrency, HighlyStructuredDateTime { + /** + * Returns the type of parameter + * + * @return a non-null type + */ + Type parameterType(); + + enum Type implements ProtobufEnum { + /** + * No parameter + */ + NONE(0), + /** + * Currency parameter + */ + CURRENCY(2), + /** + * Date time parameter + */ + DATE_TIME(3); + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredMessage.java b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredMessage.java new file mode 100644 index 000000000..8084d7aaa --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/highlyStructured/HighlyStructuredMessage.java @@ -0,0 +1,48 @@ +package it.auties.whatsapp.model.button.template.highlyStructured; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.template.hsm.HighlyStructuredFourRowTemplateTitle; +import it.auties.whatsapp.model.message.button.TemplateMessage; +import it.auties.whatsapp.model.message.model.ButtonMessage; +import it.auties.whatsapp.model.message.model.MessageType; + +import java.util.List; +import java.util.Optional; + +/** + * A model class that represents a message that contains a highly structured message inside. Not + * really clear how this could be used, contributions are welcomed. + */ +@ProtobufMessageName("Message.HighlyStructuredMessage") +public record HighlyStructuredMessage( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String namespace, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String elementName, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + List params, + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + Optional fallbackLg, + @ProtobufProperty(index = 5, type = ProtobufType.STRING) + Optional fallbackLc, + @ProtobufProperty(index = 6, type = ProtobufType.OBJECT) + List localizableParameters, + @ProtobufProperty(index = 7, type = ProtobufType.STRING) + Optional deterministicLg, + @ProtobufProperty(index = 8, type = ProtobufType.STRING) + Optional deterministicLc, + @ProtobufProperty(index = 9, type = ProtobufType.OBJECT) + TemplateMessage templateMessage +) implements ButtonMessage, HighlyStructuredFourRowTemplateTitle { + @Override + public MessageType type() { + return MessageType.HIGHLY_STRUCTURED; + } + + @Override + public Type titleType() { + return Type.HIGHLY_STRUCTURED; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredButton.java new file mode 100644 index 000000000..44a2e8f38 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredButton.java @@ -0,0 +1,58 @@ +package it.auties.whatsapp.model.button.template.hsm; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.whatsapp.model.button.template.highlyStructured.HighlyStructuredMessage; + +/** + * A model that represents all types of hydrated buttons + */ +public sealed interface HighlyStructuredButton extends ProtobufMessage permits HighlyStructuredCallButton, HighlyStructuredQuickReplyButton, HighlyStructuredURLButton { + /** + * Returns the text of this button + * + * @return a non-null structure if the protobuf isn't corrupted + */ + HighlyStructuredMessage text(); + + /** + * Returns the type of this button + * + * @return a non-null type + */ + Type buttonType(); + + /** + * The constants of this enumerated type describe the various types of buttons that a template can + * wrap + */ + enum Type implements ProtobufEnum { + /** + * No button + */ + NONE(0), + /** + * Quick reply button + */ + QUICK_REPLY(1), + /** + * Url button + */ + URL(2), + /** + * Call button + */ + CALL(3); + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredButtonTemplate.java b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredButtonTemplate.java new file mode 100644 index 000000000..a7e335ff6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredButtonTemplate.java @@ -0,0 +1,83 @@ +package it.auties.whatsapp.model.button.template.hsm; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents a template for a button + */ +@ProtobufMessageName("HydratedTemplateButton") +public record HighlyStructuredButtonTemplate( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Optional highlyStructuredQuickReplyButton, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Optional highlyStructuredUrlButton, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + Optional highlyStructuredCallButton, + @ProtobufProperty(index = 4, type = ProtobufType.UINT32) + int index +) implements ProtobufMessage { + /** + * Constructs a new template + * + * @param highlyStructuredButton the button + * @return a non-null button template + */ + public static HighlyStructuredButtonTemplate of(HighlyStructuredButton highlyStructuredButton) { + return of(-1, highlyStructuredButton); + } + + /** + * Constructs a new template + * + * @param index the index + * @param highlyStructuredButton the button + * @return a non-null button template + */ + public static HighlyStructuredButtonTemplate of(int index, HighlyStructuredButton highlyStructuredButton) { + var builder = new HighlyStructuredButtonTemplateBuilder() + .index(index); + switch (highlyStructuredButton) { + case HighlyStructuredQuickReplyButton highlyStructuredQuickReplyButton -> + builder.highlyStructuredQuickReplyButton(highlyStructuredQuickReplyButton); + case HighlyStructuredURLButton highlyStructuredURLButton -> + builder.highlyStructuredUrlButton(highlyStructuredURLButton); + case HighlyStructuredCallButton highlyStructuredCallButton -> + builder.highlyStructuredCallButton(highlyStructuredCallButton); + case null -> { + } + } + return builder.build(); + } + + /** + * Returns this button + * + * @return a non-null optional + */ + public Optional button() { + if (highlyStructuredQuickReplyButton.isPresent()) { + return highlyStructuredQuickReplyButton; + } + + if (highlyStructuredUrlButton.isPresent()) { + return highlyStructuredUrlButton; + } + + return highlyStructuredCallButton; + } + + /** + * Returns the type of button that this message wraps + * + * @return a non-null button type + */ + public HighlyStructuredButton.Type buttonType() { + return button().map(HighlyStructuredButton::buttonType) + .orElse(HighlyStructuredButton.Type.NONE); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredCallButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredCallButton.java new file mode 100644 index 000000000..f3a1c2d82 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredCallButton.java @@ -0,0 +1,22 @@ +package it.auties.whatsapp.model.button.template.hsm; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.template.highlyStructured.HighlyStructuredMessage; + +/** + * A model class that represents a button that can start a phone call + */ +@ProtobufMessageName("TemplateButton.CallButton") +public record HighlyStructuredCallButton( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + HighlyStructuredMessage text, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + HighlyStructuredMessage phoneNumber +) implements HighlyStructuredButton { + @Override + public Type buttonType() { + return Type.CALL; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredFourRowTemplate.java b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredFourRowTemplate.java new file mode 100644 index 000000000..1518b0a5b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredFourRowTemplate.java @@ -0,0 +1,104 @@ +package it.auties.whatsapp.model.button.template.hsm; + +import it.auties.protobuf.annotation.ProtobufBuilder; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.template.TemplateFormatter; +import it.auties.whatsapp.model.button.template.highlyStructured.HighlyStructuredMessage; +import it.auties.whatsapp.model.message.standard.DocumentMessage; +import it.auties.whatsapp.model.message.standard.ImageMessage; +import it.auties.whatsapp.model.message.standard.LocationMessage; +import it.auties.whatsapp.model.message.standard.VideoOrGifMessage; + +import java.util.List; +import java.util.Optional; +import java.util.stream.IntStream; + +/** + * A model class that represents a four row template + */ +@ProtobufMessageName("Message.TemplateMessage.FourRowTemplate") +public record HighlyStructuredFourRowTemplate( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Optional titleDocument, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Optional titleHighlyStructured, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + Optional titleImage, + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + Optional titleVideo, + @ProtobufProperty(index = 5, type = ProtobufType.OBJECT) + Optional titleLocation, + @ProtobufProperty(index = 6, type = ProtobufType.OBJECT) + HighlyStructuredMessage content, + @ProtobufProperty(index = 7, type = ProtobufType.OBJECT) + Optional footer, + @ProtobufProperty(index = 8, type = ProtobufType.OBJECT) + List buttons +) implements TemplateFormatter { + @ProtobufBuilder(className = "HighlyStructuredFourRowTemplateSimpleBuilder") + static HighlyStructuredFourRowTemplate simpleBuilder(HighlyStructuredFourRowTemplateTitle title, HighlyStructuredMessage content, HighlyStructuredMessage footer, List buttons) { + var builder = new HighlyStructuredFourRowTemplateBuilder() + .buttons(getIndexedButtons(buttons)) + .footer(footer); + switch (title) { + case DocumentMessage documentMessage -> builder.titleDocument(documentMessage); + case HighlyStructuredMessage highlyStructuredMessage -> + builder.titleHighlyStructured(highlyStructuredMessage); + case ImageMessage imageMessage -> builder.titleImage(imageMessage); + case VideoOrGifMessage videoMessage -> builder.titleVideo(videoMessage); + case LocationMessage locationMessage -> builder.titleLocation(locationMessage); + case null -> { + } + } + return builder.build(); + } + + private static List getIndexedButtons(List buttons) { + return IntStream.range(0, buttons.size()).mapToObj(index -> { + var button = buttons.get(index); + return new HighlyStructuredButtonTemplate(button.highlyStructuredQuickReplyButton(), button.highlyStructuredUrlButton(), button.highlyStructuredCallButton(), index + 1); + }).toList(); + } + + /** + * Returns the type of title that this template wraps + * + * @return a non-null title type + */ + public HighlyStructuredFourRowTemplateTitle.Type titleType() { + return title().map(HighlyStructuredFourRowTemplateTitle::titleType) + .orElse(HighlyStructuredFourRowTemplateTitle.Type.NONE); + } + + /** + * Returns the title of this template + * + * @return an optional + */ + public Optional title() { + if (titleDocument.isPresent()) { + return titleDocument; + } + + if (titleHighlyStructured.isPresent()) { + return titleHighlyStructured; + } + + if (titleImage.isPresent()) { + return titleImage; + } + + if (titleVideo.isPresent()) { + return titleVideo; + } + + return titleLocation; + } + + @Override + public Type templateType() { + return TemplateFormatter.Type.FOUR_ROW; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredFourRowTemplateTitle.java b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredFourRowTemplateTitle.java new file mode 100644 index 000000000..877f0a8d9 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredFourRowTemplateTitle.java @@ -0,0 +1,63 @@ +package it.auties.whatsapp.model.button.template.hsm; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.whatsapp.model.button.template.highlyStructured.HighlyStructuredMessage; +import it.auties.whatsapp.model.message.standard.DocumentMessage; +import it.auties.whatsapp.model.message.standard.ImageMessage; +import it.auties.whatsapp.model.message.standard.LocationMessage; +import it.auties.whatsapp.model.message.standard.VideoOrGifMessage; + +/** + * A model that represents the title of a {@link HighlyStructuredFourRowTemplate} + */ +public sealed interface HighlyStructuredFourRowTemplateTitle extends ProtobufMessage permits DocumentMessage, HighlyStructuredMessage, ImageMessage, VideoOrGifMessage, LocationMessage { + /** + * Return the type of this title + * + * @return a non-null type + */ + Type titleType(); + + /** + * The constants of this enumerated type describe the various types of title that a template can + * have + */ + enum Type implements ProtobufEnum { + /** + * No title + */ + NONE(0), + /** + * Document title + */ + DOCUMENT(1), + /** + * Highly structured message title + */ + HIGHLY_STRUCTURED(2), + /** + * Image title + */ + IMAGE(3), + /** + * Video title + */ + VIDEO(4), + /** + * Location title + */ + LOCATION(5); + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredQuickReplyButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredQuickReplyButton.java new file mode 100644 index 000000000..16087a075 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredQuickReplyButton.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.model.button.template.hsm; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.template.highlyStructured.HighlyStructuredMessage; + +/** + * A model class that represents a quick reply button + */ +@ProtobufMessageName("TemplateButton.QuickReplyButton") +public record HighlyStructuredQuickReplyButton( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + HighlyStructuredMessage text, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String id +) implements HighlyStructuredButton { + public Type buttonType() { + return Type.QUICK_REPLY; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredURLButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredURLButton.java new file mode 100644 index 000000000..12e8f2f50 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hsm/HighlyStructuredURLButton.java @@ -0,0 +1,22 @@ +package it.auties.whatsapp.model.button.template.hsm; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.template.highlyStructured.HighlyStructuredMessage; + +/** + * A model class that represents an url button + */ +@ProtobufMessageName("TemplateButton.URLButton") +public record HighlyStructuredURLButton( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + HighlyStructuredMessage text, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + HighlyStructuredMessage url +) implements HighlyStructuredButton { + @Override + public Type buttonType() { + return Type.URL; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedButton.java new file mode 100644 index 000000000..d93381639 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedButton.java @@ -0,0 +1,57 @@ +package it.auties.whatsapp.model.button.template.hydrated; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; + +/** + * A model that represents all types of hydrated buttons + */ +public sealed interface HydratedButton extends ProtobufMessage permits HydratedCallButton, HydratedQuickReplyButton, HydratedURLButton { + /** + * Returns the text of this button + * + * @return a non-null string if the protobuf isn't corrupted + */ + String text(); + + /** + * Returns the type of this button + * + * @return a non-null type + */ + Type buttonType(); + + /** + * The constants of this enumerated type describe the various types of buttons that a template can + * wrap + */ + enum Type implements ProtobufEnum { + /** + * No button + */ + NONE(0), + /** + * Quick reply button + */ + QUICK_REPLY(1), + /** + * Url button + */ + URL(2), + /** + * Call button + */ + CALL(3); + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedCallButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedCallButton.java new file mode 100644 index 000000000..53d3002df --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedCallButton.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.model.button.template.hydrated; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents a hydrated button that can start a phone call + */ +@ProtobufMessageName("HydratedTemplateButton.HydratedCallButton") +public record HydratedCallButton( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String text, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String phoneNumber +) implements HydratedButton { + @Override + public Type buttonType() { + return Type.CALL; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplate.java b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplate.java new file mode 100644 index 000000000..a7fe75c25 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplate.java @@ -0,0 +1,107 @@ +package it.auties.whatsapp.model.button.template.hydrated; + +import it.auties.protobuf.annotation.ProtobufBuilder; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.template.TemplateFormatter; +import it.auties.whatsapp.model.message.standard.DocumentMessage; +import it.auties.whatsapp.model.message.standard.ImageMessage; +import it.auties.whatsapp.model.message.standard.LocationMessage; +import it.auties.whatsapp.model.message.standard.VideoOrGifMessage; + +import java.util.List; +import java.util.Optional; +import java.util.stream.IntStream; + +/** + * A model class that represents a hydrated four row template + */ +@ProtobufMessageName("Message.TemplateMessage.HydratedFourRowTemplate") +public record HydratedFourRowTemplate( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Optional titleDocument, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + Optional titleText, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + Optional titleImage, + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + Optional titleVideo, + @ProtobufProperty(index = 5, type = ProtobufType.OBJECT) + Optional titleLocation, + @ProtobufProperty(index = 6, type = ProtobufType.STRING) + String body, + @ProtobufProperty(index = 7, type = ProtobufType.STRING) + Optional footer, + @ProtobufProperty(index = 8, type = ProtobufType.OBJECT) + List hydratedButtons, + @ProtobufProperty(index = 9, type = ProtobufType.STRING) + String templateId +) implements TemplateFormatter { + @ProtobufBuilder(className = "HydratedFourRowTemplateSimpleBuilder") + static HydratedFourRowTemplate customBuilder(HydratedFourRowTemplateTitle title, String body, String footer, List buttons, String templateId) { + var builder = new HydratedFourRowTemplateBuilder() + .templateId(templateId) + .body(body) + .hydratedButtons(getIndexedButtons(buttons)) + .footer(footer); + switch (title) { + case DocumentMessage documentMessage -> builder.titleDocument(documentMessage); + case HydratedFourRowTemplateTextTitle hydratedFourRowTemplateTextTitle -> + builder.titleText(hydratedFourRowTemplateTextTitle); + case ImageMessage imageMessage -> builder.titleImage(imageMessage); + case VideoOrGifMessage videoMessage -> builder.titleVideo(videoMessage); + case LocationMessage locationMessage -> builder.titleLocation(locationMessage); + case null -> { + } + } + return builder.build(); + } + + private static List getIndexedButtons(List buttons) { + return IntStream.range(0, buttons.size()).mapToObj(index -> { + var button = buttons.get(index); + return new HydratedTemplateButton(button.quickReplyButton(), button.urlButton(), button.callButton(), index + 1); + }).toList(); + } + + /** + * Returns the type of title that this template wraps + * + * @return a non-null title type + */ + public HydratedFourRowTemplateTitle.Type titleType() { + return title().map(HydratedFourRowTemplateTitle::hydratedTitleType) + .orElse(HydratedFourRowTemplateTitle.Type.NONE); + } + + /** + * Returns the title of this template + * + * @return an optional + */ + public Optional title() { + if (titleDocument.isPresent()) { + return titleDocument; + } + + if (titleText.isPresent()) { + return titleText; + } + + if (titleImage.isPresent()) { + return titleImage; + } + + if (titleVideo.isPresent()) { + return titleVideo; + } + + return titleLocation; + } + + @Override + public Type templateType() { + return TemplateFormatter.Type.HYDRATED_FOUR_ROW; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplateTextTitle.java b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplateTextTitle.java new file mode 100644 index 000000000..fb3a18474 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplateTextTitle.java @@ -0,0 +1,25 @@ +package it.auties.whatsapp.model.button.template.hydrated; + +import it.auties.protobuf.annotation.ProtobufConverter; + +/** + * A model class that represents a hydrated four row template + */ +public record HydratedFourRowTemplateTextTitle( + String text +) implements HydratedFourRowTemplateTitle { + @ProtobufConverter + public static HydratedFourRowTemplateTextTitle of(String text) { + return new HydratedFourRowTemplateTextTitle(text); + } + + @ProtobufConverter + public String text() { + return text; + } + + @Override + public Type hydratedTitleType() { + return Type.TEXT; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplateTitle.java b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplateTitle.java new file mode 100644 index 000000000..81b7e012a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedFourRowTemplateTitle.java @@ -0,0 +1,61 @@ +package it.auties.whatsapp.model.button.template.hydrated; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.whatsapp.model.message.standard.DocumentMessage; +import it.auties.whatsapp.model.message.standard.ImageMessage; +import it.auties.whatsapp.model.message.standard.LocationMessage; +import it.auties.whatsapp.model.message.standard.VideoOrGifMessage; + +/** + * A model that represents the title of a {@link HydratedFourRowTemplate} + */ +public sealed interface HydratedFourRowTemplateTitle permits DocumentMessage, HydratedFourRowTemplateTextTitle, ImageMessage, VideoOrGifMessage, LocationMessage { + /** + * Return the type of this title + * + * @return a non-null type + */ + Type hydratedTitleType(); + + /** + * The constants of this enumerated type describe the various types of title that a template can + * wrap + */ + enum Type implements ProtobufEnum { + /** + * No title + */ + NONE(0), + /** + * Document title + */ + DOCUMENT(1), + /** + * Text title + */ + TEXT(2), + /** + * Image title + */ + IMAGE(3), + /** + * Video title + */ + VIDEO(4), + /** + * Location title + */ + LOCATION(5); + + final int index; + + Type(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedQuickReplyButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedQuickReplyButton.java new file mode 100644 index 000000000..db8c78462 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedQuickReplyButton.java @@ -0,0 +1,35 @@ +package it.auties.whatsapp.model.button.template.hydrated; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.util.Bytes; + +import java.util.HexFormat; + +/** + * A model class that represents a hydrated quick reply button + */ +@ProtobufMessageName("HydratedTemplateButton.HydratedQuickReplyButton") +public record HydratedQuickReplyButton( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String text, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String id +) implements HydratedButton { + /** + * Constructs a new HydratedQuickReplyButton from a text with a random id + * + * @param text the non-null text + * @return a non-null HydratedQuickReplyButton + */ + public static HydratedQuickReplyButton of(String text) { + var id = HexFormat.of().formatHex(Bytes.random(6)); + return new HydratedQuickReplyButton(text, id); + } + + @Override + public Type buttonType() { + return Type.QUICK_REPLY; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedTemplateButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedTemplateButton.java new file mode 100644 index 000000000..48cedc517 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedTemplateButton.java @@ -0,0 +1,85 @@ +package it.auties.whatsapp.model.button.template.hydrated; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + +/** + * A model class that represents a hydrated template for a button + */ +@ProtobufMessageName("HydratedTemplateButton") +public record HydratedTemplateButton( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + HydratedQuickReplyButton quickReplyButton, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + HydratedURLButton urlButton, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + HydratedCallButton callButton, + @ProtobufProperty(index = 4, type = ProtobufType.UINT32) + int index +) implements ProtobufMessage { + /** + * Constructs a new template button + * + * @param button the non-null button + * @return a non-null button template + */ + public static HydratedTemplateButton of(HydratedButton button) { + return of(-1, button); + } + + /** + * Constructs a new template button + * + * @param index the index + * @param button the non-null button + * @return a non-null button template + */ + public static HydratedTemplateButton of(int index, HydratedButton button) { + var builder = new HydratedTemplateButtonBuilder() + .index(index); + switch (button) { + case HydratedQuickReplyButton hydratedQuickReplyButton -> + builder.quickReplyButton(hydratedQuickReplyButton); + case HydratedURLButton hydratedURLButton -> builder.urlButton(hydratedURLButton); + case HydratedCallButton hydratedCallButton -> builder.callButton(hydratedCallButton); + case null -> { + } + } + return builder.build(); + } + + /** + * Returns this button + * + * @return a non-null optional + */ + public Optional button() { + if (quickReplyButton != null) { + return Optional.of(quickReplyButton); + } + + if (urlButton != null) { + return Optional.of(urlButton); + } + + if (callButton != null) { + return Optional.of(callButton); + } + + return Optional.empty(); + } + + /** + * Returns the type of button that this message wraps + * + * @return a non-null button type + */ + public HydratedButton.Type buttonType() { + return button().map(HydratedButton::buttonType) + .orElse(HydratedButton.Type.NONE); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedURLButton.java b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedURLButton.java new file mode 100644 index 000000000..5365f21fe --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/button/template/hydrated/HydratedURLButton.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.model.button.template.hydrated; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents a hydrated url button + */ +@ProtobufMessageName("HydratedTemplateButton.HydratedURLButton") +public record HydratedURLButton( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String text, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String url +) implements HydratedButton { + @Override + public Type buttonType() { + return Type.URL; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/call/Call.java b/src/main/java/it/auties/whatsapp/model/call/Call.java new file mode 100644 index 000000000..e592e4566 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/call/Call.java @@ -0,0 +1,25 @@ +package it.auties.whatsapp.model.call; + +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; + +public record Call( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Jid chat, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + Jid caller, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + String id, + @ProtobufProperty(index = 4, type = ProtobufType.UINT64) + long timestampSeconds, + @ProtobufProperty(index = 5, type = ProtobufType.BOOL) + boolean video, + @ProtobufProperty(index = 6, type = ProtobufType.OBJECT) + CallStatus status, + @ProtobufProperty(index = 7, type = ProtobufType.BOOL) + boolean offline +) implements ProtobufMessage { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/call/CallStatus.java b/src/main/java/it/auties/whatsapp/model/call/CallStatus.java new file mode 100644 index 000000000..fd4cc1553 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/call/CallStatus.java @@ -0,0 +1,21 @@ +package it.auties.whatsapp.model.call; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; + +public enum CallStatus implements ProtobufEnum { + RINGING(0), + ACCEPTED(1), + REJECTED(2), + TIMED_OUT(3); + + final int index; + + CallStatus(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/chat/Chat.java b/src/main/java/it/auties/whatsapp/model/chat/Chat.java new file mode 100644 index 000000000..62f8fe314 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/Chat.java @@ -0,0 +1,1137 @@ +package it.auties.whatsapp.model.chat; + +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.contact.ContactStatus; +import it.auties.whatsapp.model.info.ChatMessageInfo; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.jid.JidProvider; +import it.auties.whatsapp.model.jid.JidType; +import it.auties.whatsapp.model.media.MediaVisibility; +import it.auties.whatsapp.model.message.model.MessageCategory; +import it.auties.whatsapp.model.sync.HistorySyncMessage; +import it.auties.whatsapp.util.Clock; +import it.auties.whatsapp.util.ConcurrentLinkedHashedDequeue; + +import java.time.Instant; +import java.time.ZonedDateTime; +import java.util.*; +import java.util.concurrent.ConcurrentHashMap; +import java.util.function.Function; +import java.util.function.Predicate; + +/** + * A model class that represents a Chat. A chat can be of two types: a conversation with a contact + * or a group. This class is only a model, this means that changing its values will have no real + * effect on WhatsappWeb's servers + */ +@ProtobufMessageName("Conversation") +public final class Chat implements ProtobufMessage, JidProvider { + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + final Jid jid; + + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + final ConcurrentLinkedHashedDequeue historySyncMessages; + + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + final Jid newJid; + + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + final Jid oldJid; + + @ProtobufProperty(index = 6, type = ProtobufType.UINT32) + int unreadMessagesCount; + + @ProtobufProperty(index = 7, type = ProtobufType.BOOL) + boolean readOnly; + + @ProtobufProperty(index = 8, type = ProtobufType.BOOL) + boolean endOfHistoryTransfer; + + @ProtobufProperty(index = 9, type = ProtobufType.UINT32) + ChatEphemeralTimer ephemeralMessageDuration; + + @ProtobufProperty(index = 10, type = ProtobufType.INT64) + long ephemeralMessagesToggleTimeSeconds; + + @ProtobufProperty(index = 11, type = ProtobufType.OBJECT) + EndOfHistoryTransferType endOfHistoryTransferType; + + @ProtobufProperty(index = 12, type = ProtobufType.UINT64) + long timestampSeconds; + + @ProtobufProperty(index = 13, type = ProtobufType.STRING) + String name; + + @ProtobufProperty(index = 15, type = ProtobufType.BOOL) + boolean notSpam; + + @ProtobufProperty(index = 16, type = ProtobufType.BOOL) + boolean archived; + @ProtobufProperty(index = 17, type = ProtobufType.OBJECT) + ChatDisappear disappearInitiator; + + @ProtobufProperty(index = 19, type = ProtobufType.BOOL) + boolean markedAsUnread; + + @ProtobufProperty(index = 20, type = ProtobufType.OBJECT) + final List participants; + + @ProtobufProperty(index = 21, type = ProtobufType.BYTES) + byte[] token; + + @ProtobufProperty(index = 22, type = ProtobufType.UINT64) + long tokenTimestampSeconds; + + @ProtobufProperty(index = 23, type = ProtobufType.BYTES) + byte[] identityKey; + + @ProtobufProperty(index = 24, type = ProtobufType.UINT32) + int pinnedTimestampSeconds; + + @ProtobufProperty(index = 25, type = ProtobufType.UINT64) + ChatMute mute; + + @ProtobufProperty(index = 26, type = ProtobufType.OBJECT) + ChatWallpaper wallpaper; + + @ProtobufProperty(index = 27, type = ProtobufType.OBJECT) + MediaVisibility mediaVisibility; + + @ProtobufProperty(index = 28, type = ProtobufType.UINT64) + long tokenSenderTimestampSeconds; + + @ProtobufProperty(index = 29, type = ProtobufType.BOOL) + boolean suspended; + + @ProtobufProperty(index = 30, type = ProtobufType.BOOL) + boolean terminated; + + @ProtobufProperty(index = 31, type = ProtobufType.UINT64) + long foundationTimestampSeconds; + + @ProtobufProperty(index = 32, type = ProtobufType.STRING) + Jid founder; + @ProtobufProperty(index = 33, type = ProtobufType.STRING) + String description; + + @ProtobufProperty(index = 34, type = ProtobufType.BOOL) + boolean support; + + @ProtobufProperty(index = 35, type = ProtobufType.BOOL) + boolean parentGroup; + + @ProtobufProperty(index = 36, type = ProtobufType.BOOL) + boolean defaultSubGroup; + + @ProtobufProperty(index = 37, type = ProtobufType.STRING) + final Jid parentGroupJid; + + @ProtobufProperty(index = 38, type = ProtobufType.STRING) + String displayName; + + @ProtobufProperty(index = 39, type = ProtobufType.STRING) + Jid phoneJid; + + @ProtobufProperty(index = 40, type = ProtobufType.BOOL) + boolean shareOwnPhoneNumber; + + @ProtobufProperty(index = 41, type = ProtobufType.BOOL) + boolean pnhDuplicateLidThread; + + @ProtobufProperty(index = 42, type = ProtobufType.STRING) + Jid lidJid; + + @ProtobufProperty(index = 999, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.OBJECT) + final ConcurrentHashMap presences; + + @ProtobufProperty(index = 1000, type = ProtobufType.STRING) + final Set participantsPreKeys; + + @ProtobufProperty(index = 1001, type = ProtobufType.OBJECT) + final Set pastParticipants; + + private boolean update; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public Chat(Jid jid, ConcurrentLinkedHashedDequeue historySyncMessages, Jid newJid, Jid oldJid, int unreadMessagesCount, boolean readOnly, boolean endOfHistoryTransfer, ChatEphemeralTimer ephemeralMessageDuration, long ephemeralMessagesToggleTimeSeconds, EndOfHistoryTransferType endOfHistoryTransferType, long timestampSeconds, String name, boolean notSpam, boolean archived, ChatDisappear disappearInitiator, boolean markedAsUnread, List participants, byte[] token, long tokenTimestampSeconds, byte[] identityKey, int pinnedTimestampSeconds, ChatMute mute, ChatWallpaper wallpaper, MediaVisibility mediaVisibility, long tokenSenderTimestampSeconds, boolean suspended, boolean terminated, long foundationTimestampSeconds, Jid founder, String description, boolean support, boolean parentGroup, boolean defaultSubGroup, Jid parentGroupJid, String displayName, Jid phoneJid, boolean shareOwnPhoneNumber, boolean pnhDuplicateLidThread, Jid lidJid, ConcurrentHashMap presences, Set participantsPreKeys, Set pastParticipants) { + this.jid = jid; + this.historySyncMessages = historySyncMessages; + this.newJid = newJid; + this.oldJid = oldJid; + this.unreadMessagesCount = unreadMessagesCount; + this.readOnly = readOnly; + this.endOfHistoryTransfer = endOfHistoryTransfer; + this.ephemeralMessageDuration = ephemeralMessageDuration; + this.ephemeralMessagesToggleTimeSeconds = ephemeralMessagesToggleTimeSeconds; + this.endOfHistoryTransferType = endOfHistoryTransferType; + this.timestampSeconds = timestampSeconds; + this.name = name; + this.notSpam = notSpam; + this.archived = archived; + this.disappearInitiator = disappearInitiator; + this.markedAsUnread = markedAsUnread; + this.participants = participants; + this.token = token; + this.tokenTimestampSeconds = tokenTimestampSeconds; + this.identityKey = identityKey; + this.pinnedTimestampSeconds = pinnedTimestampSeconds; + this.mute = mute; + this.wallpaper = wallpaper; + this.mediaVisibility = mediaVisibility; + this.tokenSenderTimestampSeconds = tokenSenderTimestampSeconds; + this.suspended = suspended; + this.terminated = terminated; + this.foundationTimestampSeconds = foundationTimestampSeconds; + this.founder = founder; + this.description = description; + this.support = support; + this.parentGroup = parentGroup; + this.defaultSubGroup = defaultSubGroup; + this.parentGroupJid = parentGroupJid; + this.displayName = displayName; + this.phoneJid = phoneJid; + this.shareOwnPhoneNumber = shareOwnPhoneNumber; + this.pnhDuplicateLidThread = pnhDuplicateLidThread; + this.lidJid = lidJid; + this.presences = presences; + this.participantsPreKeys = participantsPreKeys; + this.pastParticipants = pastParticipants; + } + + /** + * Returns the name of this chat + * + * @return a non-null string + */ + public String name() { + if (name != null) { + return name; + } + + if (displayName != null) { + return displayName; + } + + return jid.user(); + } + + /** + * Returns a boolean to represent whether this chat is a group or not + * + * @return true if this chat is a group + */ + public boolean isGroup() { + return jid.type() == JidType.GROUP; + } + + /** + * Returns a boolean to represent whether this chat is pinned or not + * + * @return true if this chat is pinned + */ + public boolean isPinned() { + return pinnedTimestampSeconds != 0; + } + + /** + * Returns a boolean to represent whether ephemeral messages are enabled for this chat + * + * @return true if ephemeral messages are enabled for this chat + */ + public boolean isEphemeral() { + return ephemeralMessageDuration != ChatEphemeralTimer.OFF && ephemeralMessagesToggleTimeSeconds != 0; + } + + /** + * Returns all the unread messages in this chat + * + * @return a non-null collection + */ + public Collection unreadMessages() { + if (!hasUnreadMessages()) { + return List.of(); + } + + return historySyncMessages.stream() + .limit(unreadMessagesCount()) + .map(HistorySyncMessage::messageInfo) + .toList(); + } + + /** + * Returns a boolean to represent whether this chat has unread messages + * + * @return true if this chat has unread messages + */ + public boolean hasUnreadMessages() { + return unreadMessagesCount > 0; + } + + /** + * Returns an optional value containing the seconds this chat was pinned + * + * @return an optional + */ + public Optional pinnedTimestamp() { + return Clock.parseSeconds(pinnedTimestampSeconds); + } + + /** + * Returns the timestampSeconds for the creation of this chat in seconds since + * {@link Instant#EPOCH} + * + * @return an optional + */ + public Optional timestamp() { + return Clock.parseSeconds(timestampSeconds); + } + + /** + * Returns an optional value containing the seconds in seconds since + * {@link Instant#EPOCH} when ephemeral messages were turned on + * + * @return an optional + */ + public Optional ephemeralMessagesToggleTime() { + return Clock.parseSeconds(ephemeralMessagesToggleTimeSeconds); + } + + /** + * Returns an optional value containing the latest message in chronological terms for this chat + * + * @return an optional + */ + public Optional newestMessage() { + return Optional.ofNullable(historySyncMessages.peekLast()) + .map(HistorySyncMessage::messageInfo); + } + + /** + * Returns an optional value containing the first message in chronological terms for this chat + * + * @return an optional + */ + public Optional oldestMessage() { + return Optional.ofNullable(historySyncMessages.peekFirst()) + .map(HistorySyncMessage::messageInfo); + } + + /** + * Returns an optional value containing the latest message in chronological terms for this chat + * with type that isn't server + * + * @return an optional + */ + public Optional newestStandardMessage() { + return findMessageBy(this::isStandardMessage, true); + } + + /** + * Returns an optional value containing the first message in chronological terms for this chat + * with type that isn't server + * + * @return an optional + */ + public Optional oldestStandardMessage() { + return findMessageBy(this::isStandardMessage, false); + } + + private boolean isStandardMessage(ChatMessageInfo info) { + return !info.message().hasCategory(MessageCategory.SERVER) && info.stubType().isEmpty(); + } + + /** + * Returns an optional value containing the latest message in chronological terms for this chat + * sent from you + * + * @return an optional + */ + public Optional newestMessageFromMe() { + return findMessageBy(this::isMessageFromMe, true); + } + + /** + * Returns an optional value containing the first message in chronological terms for this chat + * sent from you + * + * @return an optional + */ + public Optional oldestMessageFromMe() { + return findMessageBy(this::isMessageFromMe, false); + } + + private boolean isMessageFromMe(ChatMessageInfo info) { + return !info.message().hasCategory(MessageCategory.SERVER) && info.stubType().isEmpty() && info.fromMe(); + } + + /** + * Returns an optional value containing the latest message in chronological terms for this chat + * with type server + * + * @return an optional + */ + public Optional newestServerMessage() { + return findMessageBy(this::isServerMessage, true); + } + + /** + * Returns an optional value containing the first message in chronological terms for this chat + * with type server + * + * @return an optional + */ + public Optional oldestServerMessage() { + return findMessageBy(this::isServerMessage, false); + } + + private boolean isServerMessage(ChatMessageInfo info) { + return info.message().hasCategory(MessageCategory.SERVER) || info.stubType().isPresent(); + } + + private Optional findMessageBy(Function filter, boolean newest) { + var descendingIterator = newest ? historySyncMessages.descendingIterator() : historySyncMessages.iterator(); + while (descendingIterator.hasNext()) { + var info = descendingIterator.next().messageInfo(); + if (filter.apply(info)) { + return Optional.of(info); + } + } + + return Optional.empty(); + } + + + /** + * Returns all the starred messages in this chat + * + * @return a non-null list of messages + */ + public Collection starredMessages() { + return historySyncMessages.stream() + .map(HistorySyncMessage::messageInfo) + .filter(ChatMessageInfo::starred) + .toList(); + } + + /** + * Returns the timestampSeconds for the creation of this chat's token + * + * @return an optional + */ + public Optional tokenTimestamp() { + return Clock.parseSeconds(tokenTimestampSeconds); + } + + /** + * Returns the timestampSeconds for the token sender creation of this chat + * + * @return an optional + */ + public Optional tokenSenderTimestamp() { + return Clock.parseSeconds(tokenSenderTimestampSeconds); + } + + /** + * Returns the timestampSeconds for the creation of this chat if it's a group + * + * @return an optional + */ + public Optional foundationTimestamp() { + return Clock.parseSeconds(foundationTimestampSeconds); + } + + /** + * Adds a new unspecified amount of messages to this chat and sorts them accordingly + * + * @param newMessages the non-null messages to add + */ + public void addMessages(Collection newMessages) { + historySyncMessages.addAll(newMessages); + this.update = true; + } + + /** + * Adds a new unspecified amount of messages to this chat and sorts them accordingly + * + * @param oldMessages the non-null messages to add + */ + public void addOldMessages(Collection oldMessages) { + oldMessages.forEach(historySyncMessages::addFirst); + this.update = true; + } + + /** + * Adds a message to the chat in the most recent slot available + * + * @param info the message to add to the chat + * @return whether the message was added + */ + public boolean addNewMessage(ChatMessageInfo info) { + var sync = new HistorySyncMessage(info, historySyncMessages.size()); + if (historySyncMessages.contains(sync)) { + return false; + } + historySyncMessages.add(sync); + this.update = true; + updateChatTimestamp(info); + return true; + } + + /** + * Adds a message to the chat in the oldest slot available + * + * @param info the message to add to the chat + * @return whether the message was added + */ + public boolean addOldMessage(HistorySyncMessage info) { + historySyncMessages.addFirst(info); + this.update = true; + return true; + } + + /** + * Remove a message from the chat + * + * @param info the message to remove + * @return whether the message was removed + */ + public boolean removeMessage(ChatMessageInfo info) { + var result = historySyncMessages.removeIf(entry -> Objects.equals(entry.messageInfo().id(), info.id())); + if (result) { + this.update = true; + } + + refreshChatTimestamp(); + return result; + } + + /** + * Remove a message from the chat + * + * @param predicate the predicate that determines if a message should be removed + * @return whether the message was removed + */ + public boolean removeMessage(Predicate predicate) { + var result = historySyncMessages.removeIf(entry -> predicate.test(entry.messageInfo())); + refreshChatTimestamp(); + return result; + } + + private void refreshChatTimestamp() { + var message = newestMessage(); + if (message.isEmpty()) { + return; + } + + updateChatTimestamp(message.get()); + } + + private void updateChatTimestamp(ChatMessageInfo info) { + if(info.timestampSeconds().isEmpty()) { + return; + } + + var newTimestamp = info.timestampSeconds() + .getAsLong(); + var oldTimeStamp = newestMessage() + .map(value -> value.timestampSeconds().orElse(0L)) + .orElse(0L); + if (oldTimeStamp > newTimestamp) { + return; + } + + this.timestampSeconds = newTimestamp; + this.update = true; + } + + /** + * Removes all messages from the chat + */ + public void removeMessages() { + historySyncMessages.clear(); + this.update = true; + } + + /** + * Returns an immutable list of messages wrapped in history syncs + * This is useful for the proto + * + * @return a non-null collection + */ + public Collection messages() { + return Collections.unmodifiableCollection(historySyncMessages); + } + + /** + * Adds a collection of participants to this chat + * + * @param participants the participants to add + */ + public void addParticipants(Collection participants) { + participants.forEach(this::addParticipant); + this.update = true; + } + + /** + * Adds a participant to this chat + * + * @param jid the non-null jid of the participant + * @param role the role of the participant + * @return whether the participant was added + */ + public boolean addParticipant(Jid jid, GroupRole role) { + var result = addParticipant(new GroupParticipant(jid, role)); + if (result) { + this.update = true; + } + + return result; + } + + /** + * Adds a participant to this chat + * + * @param participant the non-null participant + * @return whether the participant was added + */ + public boolean addParticipant(GroupParticipant participant) { + var result = participants.add(participant); + this.update = true; + return true; + } + + /** + * Removes a participant from this chat + * + * @param jid the non-null jid of the participant + * @return whether the participant was removed + */ + public boolean removeParticipant(Jid jid) { + var result = participants.removeIf(entry -> Objects.equals(entry.jid(), jid)); + if (result) { + this.update = true; + } + + return result; + } + + /** + * Finds a participant by jid + * This method only works if {@link Whatsapp#queryGroupMetadata(JidProvider)} has been called before on this chat. + * By default, all groups that have been used in the last two weeks wil be synced automatically + * + * @param jid the non-null jid of the participant + * @return the participant, if present + */ + public Optional findParticipant(Jid jid) { + return participants.stream() + .filter(entry -> Objects.equals(entry.jid(), jid)) + .findFirst(); + } + + /** + * Adds a past participant + * + * @param participant the non-null jid of the past participant + * @return whether the participant was added + */ + public boolean addPastParticipant(GroupPastParticipant participant) { + var result = pastParticipants.add(participant); + if (result) { + this.update = true; + } + + return result; + } + + /** + * Adds a collection of past participants + * + * @param pastParticipants the non-null list of past participants + * @return whether the participant were added + */ + public boolean addPastParticipants(List pastParticipants) { + var result = true; + for (var pastParticipant : pastParticipants) { + result &= this.pastParticipants.add(pastParticipant); + } + + if (result) { + this.update = true; + } + + return result; + } + + /** + * Removes a past participant + * + * @param jid the non-null jid of the past participant + * @return whether the participant was removed + */ + public boolean removePastParticipant(Jid jid) { + var result = pastParticipants.removeIf(entry -> Objects.equals(entry.jid(), jid)); + if (result) { + this.update = true; + } + + return result; + } + + /** + * Finds a past participant by jid + * + * @param jid the non-null jid of the past participant + * @return the past participant, if present + */ + public Optional findPastParticipant(Jid jid) { + return pastParticipants.stream() + .filter(entry -> Objects.equals(entry.jid(), jid)) + .findFirst(); + } + + public Set participantsPreKeys() { + return Collections.unmodifiableSet(participantsPreKeys); + } + + public void addParticipantsPreKeys(Collection jids) { + participantsPreKeys.addAll(jids); + this.update = true; + } + + public void clearParticipantsPreKeys() { + participantsPreKeys.clear(); + this.update = true; + } + + /** + * Checks if this chat is equal to another chat + * + * @param other the chat + * @return a boolean + */ + public boolean equals(Object other) { + return other instanceof Chat that + && Objects.equals(this.jid(), that.jid()); + } + + /** + * Returns this object as a jid + * + * @return a non-null jid + */ + @Override + public Jid toJid() { + return jid(); + } + + /** + * Returns the hash code for this chat + * + * @return an int + */ + @Override + public int hashCode() { + return Objects.hash(jid()); + } + + public Jid jid() { + return jid; + } + + public Collection historySyncMessages() { + return historySyncMessages; + } + + public Optional newJid() { + return Optional.ofNullable(newJid); + } + + public Optional oldJid() { + return Optional.ofNullable(oldJid); + } + + public int unreadMessagesCount() { + return unreadMessagesCount; + } + + public boolean readOnly() { + return readOnly; + } + + public boolean endOfHistoryTransfer() { + return endOfHistoryTransfer; + } + + public ChatEphemeralTimer ephemeralMessageDuration() { + return ephemeralMessageDuration; + } + + public long ephemeralMessagesToggleTimeSeconds() { + return ephemeralMessagesToggleTimeSeconds; + } + + public Optional endOfHistoryTransferType() { + return Optional.ofNullable(endOfHistoryTransferType); + } + + public long timestampSeconds() { + return timestampSeconds; + } + + public boolean notSpam() { + return notSpam; + } + + public boolean archived() { + return archived; + } + + public Optional disappearInitiator() { + return Optional.ofNullable(disappearInitiator); + } + + public boolean markedAsUnread() { + return markedAsUnread; + } + + public List participants() { + return Collections.unmodifiableList(participants); + } + + public Optional token() { + return Optional.ofNullable(token); + } + + public long tokenTimestampSeconds() { + return tokenTimestampSeconds; + } + + public Optional identityKey() { + return Optional.ofNullable(identityKey); + } + + public int pinnedTimestampSeconds() { + return pinnedTimestampSeconds; + } + + public ChatMute mute() { + return mute; + } + + public Optional wallpaper() { + return Optional.ofNullable(wallpaper); + } + + public MediaVisibility mediaVisibility() { + return mediaVisibility; + } + + public long tokenSenderTimestampSeconds() { + return tokenSenderTimestampSeconds; + } + + public boolean suspended() { + return suspended; + } + + public boolean terminated() { + return terminated; + } + + public long foundationTimestampSeconds() { + return foundationTimestampSeconds; + } + + public Optional founder() { + return Optional.ofNullable(founder); + } + + public Optional description() { + return Optional.ofNullable(description); + } + + public boolean support() { + return support; + } + + public boolean parentGroup() { + return parentGroup; + } + + public boolean defaultSubGroup() { + return defaultSubGroup; + } + + public Optional parentGroupJid() { + return Optional.ofNullable(parentGroupJid); + } + + public Optional displayName() { + return Optional.ofNullable(displayName); + } + + public Optional phoneJid() { + return Optional.ofNullable(phoneJid); + } + + public boolean pnhDuplicateLidThread() { + return pnhDuplicateLidThread; + } + + public Optional lidJid() { + return Optional.ofNullable(lidJid); + } + + public ConcurrentHashMap presences() { + return presences; + } + + public Set pastParticipants() { + return pastParticipants; + } + + public boolean hasName() { + return name != null; + } + + public boolean shareOwnPhoneNumber() { + return shareOwnPhoneNumber; + } + + public Chat setUnreadMessagesCount(int unreadMessagesCount) { + this.unreadMessagesCount = unreadMessagesCount; + this.update = true; + return this; + } + + public Chat setReadOnly(boolean readOnly) { + this.readOnly = readOnly; + this.update = true; + return this; + } + + public Chat setEndOfHistoryTransfer(boolean endOfHistoryTransfer) { + this.endOfHistoryTransfer = endOfHistoryTransfer; + this.update = true; + return this; + } + + public Chat setEphemeralMessageDuration(ChatEphemeralTimer ephemeralMessageDuration) { + this.ephemeralMessageDuration = ephemeralMessageDuration; + this.update = true; + return this; + } + + public Chat setEphemeralMessagesToggleTimeSeconds(long ephemeralMessagesToggleTimeSeconds) { + this.ephemeralMessagesToggleTimeSeconds = ephemeralMessagesToggleTimeSeconds; + this.update = true; + return this; + } + + public Chat setEndOfHistoryTransferType(EndOfHistoryTransferType endOfHistoryTransferType) { + this.endOfHistoryTransferType = endOfHistoryTransferType; + this.update = true; + return this; + } + + public Chat setTimestampSeconds(long timestampSeconds) { + this.timestampSeconds = timestampSeconds; + this.update = true; + return this; + } + + public Chat setName(String name) { + this.name = name; + this.update = true; + return this; + } + + public Chat setNotSpam(boolean notSpam) { + this.notSpam = notSpam; + this.update = true; + return this; + } + + public Chat setArchived(boolean archived) { + this.archived = archived; + this.update = true; + return this; + } + + public Chat setDisappearInitiator(ChatDisappear disappearInitiator) { + this.disappearInitiator = disappearInitiator; + this.update = true; + return this; + } + + public Chat setMarkedAsUnread(boolean markedAsUnread) { + this.markedAsUnread = markedAsUnread; + this.update = true; + return this; + } + + public Chat setToken(byte[] token) { + this.token = token; + this.update = true; + return this; + } + + public Chat setTokenTimestampSeconds(long tokenTimestampSeconds) { + this.tokenTimestampSeconds = tokenTimestampSeconds; + this.update = true; + return this; + } + + public Chat setIdentityKey(byte[] identityKey) { + this.identityKey = identityKey; + this.update = true; + return this; + } + + public Chat setPinnedTimestampSeconds(int pinnedTimestampSeconds) { + this.pinnedTimestampSeconds = pinnedTimestampSeconds; + this.update = true; + return this; + } + + public Chat setMute(ChatMute mute) { + this.mute = mute; + this.update = true; + return this; + } + + public Chat setWallpaper(ChatWallpaper wallpaper) { + this.wallpaper = wallpaper; + this.update = true; + return this; + } + + public Chat setMediaVisibility(MediaVisibility mediaVisibility) { + this.mediaVisibility = mediaVisibility; + this.update = true; + return this; + } + + public Chat setTokenSenderTimestampSeconds(long tokenSenderTimestampSeconds) { + this.tokenSenderTimestampSeconds = tokenSenderTimestampSeconds; + this.update = true; + return this; + } + + public Chat setSuspended(boolean suspended) { + this.suspended = suspended; + this.update = true; + return this; + } + + public Chat setTerminated(boolean terminated) { + this.terminated = terminated; + this.update = true; + return this; + } + + public Chat setFoundationTimestampSeconds(long foundationTimestampSeconds) { + this.foundationTimestampSeconds = foundationTimestampSeconds; + this.update = true; + return this; + } + + public Chat setFounder(Jid founder) { + this.founder = founder; + this.update = true; + return this; + } + + public Chat setDescription(String description) { + this.description = description; + this.update = true; + return this; + } + + public Chat setSupport(boolean support) { + this.support = support; + this.update = true; + return this; + } + + public Chat setParentGroup(boolean parentGroup) { + this.parentGroup = parentGroup; + this.update = true; + return this; + } + + public Chat setDefaultSubGroup(boolean defaultSubGroup) { + this.defaultSubGroup = defaultSubGroup; + this.update = true; + return this; + } + + public Chat setDisplayName(String displayName) { + this.displayName = displayName; + this.update = true; + return this; + } + + public Chat setPhoneJid(Jid phoneJid) { + this.phoneJid = phoneJid; + this.update = true; + return this; + } + + public Chat setShareOwnPhoneNumber(boolean shareOwnPhoneNumber) { + this.shareOwnPhoneNumber = shareOwnPhoneNumber; + this.update = true; + return this; + } + + public Chat setPnhDuplicateLidThread(boolean pnhDuplicateLidThread) { + this.pnhDuplicateLidThread = pnhDuplicateLidThread; + this.update = true; + return this; + } + + public Chat setLidJid(Jid lidJid) { + this.lidJid = lidJid; + this.update = true; + return this; + } + + public boolean hasUpdate() { + return update; + } + + /** + * The constants of this enumerated type describe the various types of transfers that can regard a + * chat history sync + */ + @ProtobufMessageName("Conversation.EndOfHistoryTransferType") + public enum EndOfHistoryTransferType implements ProtobufEnum { + /** + * Complete, but more messages remain on the phone + */ + COMPLETE_BUT_MORE_MESSAGES_REMAIN_ON_PRIMARY(0), + + /** + * Complete and no more messages remain on the phone + */ + COMPLETE_AND_NO_MORE_MESSAGE_REMAIN_ON_PRIMARY(1); + + final int index; + + EndOfHistoryTransferType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/chat/ChatDisappear.java b/src/main/java/it/auties/whatsapp/model/chat/ChatDisappear.java new file mode 100644 index 000000000..8e475b5cb --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/ChatDisappear.java @@ -0,0 +1,54 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Objects; + +/** + * A model that represents a chat disappear mode + */ +@ProtobufMessageName("DisappearingMode") +public record ChatDisappear( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Initiator initiator +) implements ProtobufMessage { + /** + * The constants of this enumerated type describe the various actors that can initialize + * disappearing messages in a chat + */ + @ProtobufMessageName("DisappearingMode.Initiator") + public enum Initiator implements ProtobufEnum { + /** + * Changed in chat + */ + CHANGED_IN_CHAT(0), + /** + * Initiated by me + */ + INITIATED_BY_ME(1), + /** + * Initiated by other + */ + INITIATED_BY_OTHER(2); + + final int index; + + Initiator(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } + + @Override + public int hashCode() { + return Objects.hashCode(initiator.index()); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/chat/ChatEphemeralTimer.java b/src/main/java/it/auties/whatsapp/model/chat/ChatEphemeralTimer.java new file mode 100644 index 000000000..5df95501b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/ChatEphemeralTimer.java @@ -0,0 +1,63 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.protobuf.annotation.ProtobufConverter; +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; + +import java.time.Duration; +import java.util.Arrays; + +/** + * Enum representing the ChatEphemeralTimer period. Each constant is associated with a specific + * duration period. + */ +public enum ChatEphemeralTimer implements ProtobufEnum { + /** + * ChatEphemeralTimer with duration of 0 days. + */ + OFF(0, Duration.ofDays(0)), + + /** + * ChatEphemeralTimer with duration of 1 day. + */ + ONE_DAY(1, Duration.ofDays(1)), + + /** + * ChatEphemeralTimer with duration of 7 days. + */ + ONE_WEEK(2, Duration.ofDays(7)), + + /** + * ChatEphemeralTimer with duration of 90 days. + */ + THREE_MONTHS(3, Duration.ofDays(90)); + + private final Duration period; + final int index; + + ChatEphemeralTimer(@ProtobufEnumIndex int index, Duration period) { + this.index = index; + this.period = period; + } + + public int index() { + return index; + } + + public Duration period() { + return period; + } + + @ProtobufConverter + public static ChatEphemeralTimer of(int value) { + return Arrays.stream(values()) + .filter(entry -> entry.period().toSeconds() == value || entry.period().toDays() == value) + .findFirst() + .orElse(OFF); + } + + @ProtobufConverter + public int periodSeconds() { + return (int) period.toSeconds(); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/chat/ChatMute.java b/src/main/java/it/auties/whatsapp/model/chat/ChatMute.java new file mode 100644 index 000000000..9ac07c457 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/ChatMute.java @@ -0,0 +1,156 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.protobuf.annotation.ProtobufConverter; +import it.auties.whatsapp.util.Clock; + +import java.time.Instant; +import java.time.ZonedDateTime; +import java.util.Optional; + +/** + * An immutable model class that represents a mute + * + * @param endTimeStamp the end date of the mute associated with this object stored as second since + * {@link Instant#EPOCH} + */ +public record ChatMute(long endTimeStamp) { + /** + * Not muted flag + */ + private static final long NOT_MUTED_FLAG = 0; + + /** + * Muted flag + */ + private static final long MUTED_INDEFINITELY_FLAG = -1; + + /** + * Not muted constant + */ + private static final ChatMute NOT_MUTED = new ChatMute(NOT_MUTED_FLAG); + + /** + * Muted constant + */ + private static final ChatMute MUTED_INDEFINITELY = new ChatMute(MUTED_INDEFINITELY_FLAG); + + /** + * Constructs a new not muted ChatMute + * + * @return a non-null mute + */ + public static ChatMute notMuted() { + return NOT_MUTED; + } + + /** + * Constructs a new muted ChatMute + * + * @return a non-null mute + */ + public static ChatMute muted() { + return MUTED_INDEFINITELY; + } + + /** + * Constructs a new mute that lasts eight hours + * + * @return a non-null mute + */ + public static ChatMute mutedForEightHours() { + return muted(ZonedDateTime.now().plusHours(8).toEpochSecond()); + } + + /** + * Do not use this method, reserved for protobuf + */ + @ProtobufConverter + public static ChatMute ofProtobuf(long object) { + return muted(object); + } + + /** + * Constructs a new mute for a duration in endTimeStamp + * + * @param seconds can be null and is considered as not muted + * @return a non-null mute + */ + public static ChatMute muted(Long seconds) { + if (seconds == null || seconds == NOT_MUTED_FLAG) { + return NOT_MUTED; + } + if (seconds == MUTED_INDEFINITELY_FLAG) { + return MUTED_INDEFINITELY; + } + return new ChatMute(seconds); + } + + /** + * Constructs a new mute that lasts one week + * + * @return a non-null mute + */ + public static ChatMute mutedForOneWeek() { + return muted(ZonedDateTime.now().plusWeeks(1).toEpochSecond()); + } + + /** + * Returns whether the chat associated with this object is muted or not. + * + * @return true if the chat associated with this object is muted + */ + public boolean isMuted() { + return type() != Type.NOT_MUTED; + } + + /** + * Returns a non-null enum that describes the type of mute for this object + * + * @return a non-null enum that describes the type of mute for this object + */ + public Type type() { + if (endTimeStamp == MUTED_INDEFINITELY_FLAG) { + return Type.MUTED_INDEFINITELY; + } + if (endTimeStamp == NOT_MUTED_FLAG) { + return Type.NOT_MUTED; + } + return Type.MUTED_FOR_TIMEFRAME; + } + + /** + * Returns the date when this mute expires if the chat is muted and not indefinitely + * + * @return a non-empty optional date if {@link ChatMute#endTimeStamp} > 0 + */ + public Optional end() { + return Clock.parseSeconds(endTimeStamp); + } + + @ProtobufConverter + public long endTimeStamp() { + return endTimeStamp; + } + + /** + * The constants of this enumerated type describe the various types of mute a {@link ChatMute} can + * describe + */ + public enum Type { + /** + * This constant describes a {@link ChatMute} that holds a seconds greater than 0 Simply put, + * {@link ChatMute#endTimeStamp()} > 0 + */ + MUTED_FOR_TIMEFRAME, + /** + * This constant describes a {@link ChatMute} that holds a seconds equal to -1 Simply put, + * {@link ChatMute#endTimeStamp()} == -1 + */ + MUTED_INDEFINITELY, + /** + * This constant describes a {@link ChatMute} that holds a seconds equal to 0 Simply put, + * {@link ChatMute#endTimeStamp()} == 0 + */ + NOT_MUTED + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/chat/ChatSettingPolicy.java b/src/main/java/it/auties/whatsapp/model/chat/ChatSettingPolicy.java new file mode 100644 index 000000000..64f8de492 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/ChatSettingPolicy.java @@ -0,0 +1,25 @@ +package it.auties.whatsapp.model.chat; + +/** + * The constants of this enumerated type describe the various policies that can be enforced for a {@link GroupSetting} or {@link CommunitySetting} in a {@link Chat} + */ +public enum ChatSettingPolicy { + /** + * Allows both admins and users + */ + ANYONE, + /** + * Allows only admins + */ + ADMINS; + + /** + * Returns a GroupPolicy based on a boolean value obtained from Whatsapp + * + * @param input the boolean value obtained from Whatsapp + * @return a non-null GroupPolicy + */ + public static ChatSettingPolicy of(boolean input) { + return input ? ADMINS : ANYONE; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/chat/ChatWallpaper.java b/src/main/java/it/auties/whatsapp/model/chat/ChatWallpaper.java new file mode 100644 index 000000000..c5eeb7d7c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/ChatWallpaper.java @@ -0,0 +1,18 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +/** + * A model class that represents the wallpaper of a chat. + */ +@ProtobufMessageName("WallpaperSettings") +public record ChatWallpaper( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String filename, + @ProtobufProperty(index = 2, type = ProtobufType.UINT32) + int opacity +) implements ProtobufMessage { +} diff --git a/src/main/java/it/auties/whatsapp/model/chat/CommunitySetting.java b/src/main/java/it/auties/whatsapp/model/chat/CommunitySetting.java new file mode 100644 index 000000000..fcff65e1e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/CommunitySetting.java @@ -0,0 +1,11 @@ +package it.auties.whatsapp.model.chat; + +/** + * The constants of this enumerated type describe the various settings that can be toggled for a community + */ +public enum CommunitySetting { + /** + * Who can add and remove groups from a community + */ + MODIFY_GROUPS +} diff --git a/src/main/java/it/auties/whatsapp/model/chat/GroupAction.java b/src/main/java/it/auties/whatsapp/model/chat/GroupAction.java new file mode 100644 index 000000000..3b3806fad --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/GroupAction.java @@ -0,0 +1,37 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.contact.Contact; + +/** + * The constants of this enumerated type describe the various actions that can be executed on a + * {@link Contact} in a {@link Chat}. Said chat should be a group: {@link Chat#isGroup()}. Said + * actions can be executed using various methods in {@link Whatsapp}. + */ +public enum GroupAction { + /** + * Adds a contact to a group + */ + ADD, + /** + * Removes a contact from a group + */ + REMOVE, + /** + * Promotes a contact to admin in a group + */ + PROMOTE, + /** + * Demotes a contact to user in a group + */ + DEMOTE; + + /** + * Returns the name of this enumerated constant + * + * @return a lowercase non-null String + */ + public String data() { + return name().toLowerCase(); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/chat/GroupMetadata.java b/src/main/java/it/auties/whatsapp/model/chat/GroupMetadata.java new file mode 100644 index 000000000..e69335259 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/GroupMetadata.java @@ -0,0 +1,29 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.whatsapp.model.jid.Jid; + +import java.time.ZonedDateTime; +import java.util.List; +import java.util.Map; +import java.util.Optional; + +/** + * This model class represents the metadata of a group + */ +public record GroupMetadata( + Jid jid, + String subject, + Optional subjectAuthor, + Optional subjectTimestamp, + Optional foundationTimestamp, + Optional founder, + Optional description, + Optional descriptionId, + Map policies, + List participants, + Optional ephemeralExpiration, + boolean isCommunity, + boolean isOpenCommunity +) { + +} diff --git a/src/main/java/it/auties/whatsapp/model/chat/GroupParticipant.java b/src/main/java/it/auties/whatsapp/model/chat/GroupParticipant.java new file mode 100644 index 000000000..8e3f1dbe4 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/GroupParticipant.java @@ -0,0 +1,53 @@ +package it.auties.whatsapp.model.chat; + +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; + +import java.util.Objects; + +/** + * A model class that represents a participant of a group. + */ +@ProtobufMessageName("GroupParticipant") +public final class GroupParticipant implements ProtobufMessage { + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + private final Jid jid; + + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + private GroupRole role; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public GroupParticipant(Jid jid, GroupRole role) { + this.jid = jid; + this.role = Objects.requireNonNullElse(role, GroupRole.USER); + } + + public Jid jid() { + return jid; + } + + public GroupRole role() { + return role; + } + + public void setRole(GroupRole role) { + this.role = role; + } + + @Override + public String toString() { + return "GroupParticipant{" + + "jid=" + jid + + ", role=" + role + + '}'; + } + + @Override + public int hashCode() { + return Objects.hash(jid, role.index()); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/chat/GroupPastParticipant.java b/src/main/java/it/auties/whatsapp/model/chat/GroupPastParticipant.java new file mode 100644 index 000000000..c168b0819 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/GroupPastParticipant.java @@ -0,0 +1,62 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + + +/** + * Class representing a past participant in a chat + */ +@ProtobufMessageName("PastParticipant") +public record GroupPastParticipant( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Jid jid, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + Reason reason, + @ProtobufProperty(index = 3, type = ProtobufType.UINT64) + long timestampSeconds +) implements ProtobufMessage { + + /** + * Returns when the past participant left the chat + * + * @return an optional + */ + public Optional timestamp() { + return Clock.parseSeconds(timestampSeconds); + } + + /** + * Enum representing the errorReason for a past participant leaving the chat. + */ + @ProtobufMessageName("PastParticipant.LeaveReason") + public enum Reason implements ProtobufEnum { + /** + * The past participant left the chat voluntarily. + */ + LEFT(0), + /** + * The past participant was removed from the chat. + */ + REMOVED(1); + + final int index; + + Reason(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/chat/GroupPastParticipants.java b/src/main/java/it/auties/whatsapp/model/chat/GroupPastParticipants.java new file mode 100644 index 000000000..b60753758 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/GroupPastParticipants.java @@ -0,0 +1,22 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; + +import java.util.List; + +/** + * Class representing a list of past participants in a chat group + */ +@ProtobufMessageName("PastParticipants") +public record GroupPastParticipants( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Jid groupJid, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + List pastParticipants +) implements ProtobufMessage { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/chat/GroupRole.java b/src/main/java/it/auties/whatsapp/model/chat/GroupRole.java new file mode 100644 index 000000000..f532acb82 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/GroupRole.java @@ -0,0 +1,53 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.whatsapp.api.Whatsapp; + +import java.util.Arrays; +import java.util.NoSuchElementException; +import java.util.Objects; + +/** + * The constants of this enumerated type describe the various roles that a {@link GroupParticipant} + * can have in a group. Said roles can be changed using various methods in {@link Whatsapp}. + */ +@ProtobufMessageName("GroupParticipant.Rank") +public enum GroupRole implements ProtobufEnum { + /** + * A participant of the group with no special powers + */ + USER(0, null), + /** + * A participant of the group with administration powers + */ + ADMIN(1, "admin"), + /** + * The founder of the group, also known as super admin + */ + FOUNDER(2, "superadmin"); + + final int index; + private final String data; + + GroupRole(@ProtobufEnumIndex int index, String data) { + this.index = index; + this.data = data; + } + + public static GroupRole of(String input) { + return Arrays.stream(values()) + .filter(entry -> Objects.equals(entry.data(), input)) + .findFirst() + .orElseThrow(() -> new NoSuchElementException("Cannot find GroupRole for %s".formatted(input))); + } + + public int index() { + return index; + } + + public String data() { + return data; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/chat/GroupSetting.java b/src/main/java/it/auties/whatsapp/model/chat/GroupSetting.java new file mode 100644 index 000000000..9c0fc9d9c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/chat/GroupSetting.java @@ -0,0 +1,29 @@ +package it.auties.whatsapp.model.chat; + +import it.auties.whatsapp.api.Whatsapp; + +/** + * The constants of this enumerated type describe the various settings that can be toggled for a + * group. Said settings can be changed using various methods in {@link Whatsapp}. + */ +public enum GroupSetting { + /** + * Who can edit the metadata of a group + */ + EDIT_GROUP_INFO, + + /** + * Who can send messages in a group + */ + SEND_MESSAGES, + + /** + * Who can add new members + */ + ADD_PARTICIPANTS, + + /** + * Who can accept new members + */ + APPROVE_PARTICIPANTS +} diff --git a/src/main/java/it/auties/whatsapp/model/companion/CompanionDevice.java b/src/main/java/it/auties/whatsapp/model/companion/CompanionDevice.java new file mode 100644 index 000000000..87d80f9cf --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/companion/CompanionDevice.java @@ -0,0 +1,171 @@ +package it.auties.whatsapp.model.companion; + +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.signal.auth.UserAgent.PlatformType; +import it.auties.whatsapp.model.signal.auth.Version; + +import java.util.List; +import java.util.Optional; +import java.util.concurrent.ThreadLocalRandom; + +/** + * A model for a mobile companion + * + * @param model the non-null model of the device + * @param manufacturer the non-null manufacturer of the device + * @param platform the non-null os of the device + * @param appVersion the version of the app, or empty + * @param osVersion the non-null os version of the device + */ +public record CompanionDevice( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String model, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String manufacturer, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + PlatformType platform, + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + Optional appVersion, + @ProtobufProperty(index = 5, type = ProtobufType.OBJECT) + Version osVersion +) implements ProtobufMessage { + private static final List IPHONES = List.of( + "iPhone_11", + "iPhone_11_Pro", + "iPhone_11_Pro_Max", + "iPhone_12", + "iPhone_12_Pro", + "iPhone_12_Pro_Max", + "iPhone_13", + "iPhone_13_Pro", + "iPhone_13_Pro_Max", + "iPhone_14", + "iPhone_14_Plus", + "iPhone_14_Pro", + "iPhone_14_Pro_Max", + "iPhone_15", + "iPhone_15_Plus", + "iPhone_15_Pro", + "iPhone_15_Pro_Max" + ); + + public static CompanionDevice web() { + return web(null); + } + + public static CompanionDevice web(Version appVersion) { + return new CompanionDevice( + "Chrome", + "Google", + PlatformType.WEB, + Optional.ofNullable(appVersion), + Version.of("1.0") + ); + } + + public static CompanionDevice ios(boolean business) { + return ios(null, business); + } + + public static CompanionDevice ios(Version appVersion, boolean business) { + return new CompanionDevice( + IPHONES.get(ThreadLocalRandom.current().nextInt(IPHONES.size())), + "Apple", + business ? PlatformType.IOS_BUSINESS : PlatformType.IOS, + Optional.ofNullable(appVersion), + Version.of(ThreadLocalRandom.current().nextBoolean() ? "17.2.1" : "17.3.1") + ); + } + + public static CompanionDevice android(boolean business) { + return android(null, business); + } + + + public static CompanionDevice android(Version appVersion, boolean business) { + return new CompanionDevice( + "MI_" + ThreadLocalRandom.current().nextInt(6, 15), + "Xiaomi", + business ? PlatformType.ANDROID_BUSINESS : PlatformType.ANDROID, + Optional.ofNullable(appVersion), + Version.of(String.valueOf(ThreadLocalRandom.current().nextInt(8, 13))) + ); + } + + public static CompanionDevice kaiOs() { + return kaiOs(null); + } + + public static CompanionDevice kaiOs(Version appVersion) { + return new CompanionDevice( + "8110", + "Nokia", + PlatformType.KAIOS, + Optional.ofNullable(appVersion), + Version.of("2.5.4") + ); + } + + public String toUserAgent(Version appVersion) { + return "WhatsApp/%s %s/%s Device/%s".formatted( + appVersion, + platformName(), + deviceVersion(), + deviceName() + ); + } + + public CompanionDevice toPersonal() { + if(!platform.isBusiness()) { + return this; + } + + return new CompanionDevice( + model, + manufacturer, + platform.toPersonal(), + appVersion, + osVersion + ); + } + + public CompanionDevice toBusiness() { + if(platform.isBusiness()) { + return this; + } + + return new CompanionDevice( + model, + manufacturer, + platform.toBusiness(), + appVersion, + osVersion + ); + } + + private String deviceVersion() { + return platform.isKaiOs() ? "%s+20190925153113".formatted(osVersion) : osVersion.toString(); + } + + private String deviceName() { + return switch (platform()) { + case ANDROID, ANDROID_BUSINESS -> manufacturer + "-" + model; + case IOS, IOS_BUSINESS -> model; + case KAIOS -> manufacturer + "+" + model; + default -> throw new IllegalStateException("Unsupported mobile os"); + }; + } + + private String platformName() { + return switch (platform()) { + case ANDROID -> "Android"; + case ANDROID_BUSINESS -> "SMBA"; + case IOS -> "iOS"; + case IOS_BUSINESS -> "SMB iOS"; + case KAIOS -> "KaiOS"; + default -> throw new IllegalStateException("Unsupported mobile os"); + }; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/companion/CompanionHashState.java b/src/main/java/it/auties/whatsapp/model/companion/CompanionHashState.java new file mode 100644 index 000000000..edd440f4b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/companion/CompanionHashState.java @@ -0,0 +1,128 @@ +package it.auties.whatsapp.model.companion; + +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.node.Attributes; +import it.auties.whatsapp.model.node.Node; +import it.auties.whatsapp.model.sync.PatchType; + +import java.util.Arrays; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +import static it.auties.whatsapp.model.node.Node.of; + +public final class CompanionHashState implements ProtobufMessage { + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + private PatchType type; + + @ProtobufProperty(index = 2, type = ProtobufType.INT64) + private long version; + + @ProtobufProperty(index = 3, type = ProtobufType.BYTES) + private byte[] hash; + + @ProtobufProperty(index = 4, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.BYTES) + private Map indexValueMap; + + public CompanionHashState(PatchType type) { + this(type, 0); + } + + public CompanionHashState(PatchType type, long version) { + this.type = type; + this.version = version; + this.hash = new byte[128]; + this.indexValueMap = new HashMap<>(); + } + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public CompanionHashState(PatchType type, long version, byte[] hash, Map indexValueMap) { + this.type = type; + this.version = version; + this.hash = hash; + this.indexValueMap = indexValueMap; + } + + public Node toNode() { + var attributes = Attributes.of() + .put("name", type) + .put("version", version) + .put("return_snapshot", version == 0) + .toMap(); + return of("collection", attributes); + } + + public CompanionHashState copy() { + return new CompanionHashState(type, version, Arrays.copyOf(hash, hash.length), new HashMap<>(indexValueMap)); + } + + private boolean checkIndexEquality(CompanionHashState that) { + if (indexValueMap.size() != that.indexValueMap().size()) { + return false; + } + return indexValueMap().entrySet() + .stream() + .allMatch(entry -> checkIndexEntryEquality(that, entry.getKey(), entry.getValue())); + } + + private static boolean checkIndexEntryEquality(CompanionHashState that, String thisKey, byte[] thisValue) { + var thatValue = that.indexValueMap().get(thisKey); + return thatValue != null && Arrays.equals(thatValue, thisValue); + } + + public PatchType type() { + return this.type; + } + + public long version() { + return this.version; + } + + public byte[] hash() { + return this.hash; + } + + public Map indexValueMap() { + return this.indexValueMap; + } + + public CompanionHashState setType(PatchType name) { + this.type = name; + return this; + } + + public CompanionHashState setVersion(long version) { + this.version = version; + return this; + } + + public CompanionHashState setHash(byte[] hash) { + this.hash = hash; + return this; + } + + public CompanionHashState setIndexValueMap(Map indexValueMap) { + this.indexValueMap = indexValueMap; + return this; + } + + + @Override + public boolean equals(Object o) { + return o instanceof CompanionHashState that + && this.version == that.version() + && this.type == that.type() + && Arrays.equals(this.hash, that.hash()) && checkIndexEquality(that); + } + + @Override + public int hashCode() { + var result = Objects.hash(type, version, indexValueMap); + result = 31 * result + Arrays.hashCode(hash); + return result; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/companion/CompanionLinkResult.java b/src/main/java/it/auties/whatsapp/model/companion/CompanionLinkResult.java new file mode 100644 index 000000000..96c79bf2a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/companion/CompanionLinkResult.java @@ -0,0 +1,22 @@ +package it.auties.whatsapp.model.companion; + +/** + * The constants of this enumeration describe the various types of recommendedChannels that can be yielded by a new device's registration through the mobile api + */ +public enum CompanionLinkResult { + /** + * The device was successfully linked + */ + SUCCESS, + + /** + * The limit of devices, as of now four, has already been reached + */ + MAX_DEVICES_ERROR, + + /** + * The device couldn't be linked because of an unknown error + * This usually means that the qr code is no longer valid + */ + RETRY_ERROR +} diff --git a/src/main/java/it/auties/whatsapp/model/companion/CompanionPatch.java b/src/main/java/it/auties/whatsapp/model/companion/CompanionPatch.java new file mode 100644 index 000000000..24fd3cb78 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/companion/CompanionPatch.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.model.companion; + +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; + +public record CompanionPatch( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Jid companion, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + CompanionHashState state +) implements ProtobufMessage { + +} diff --git a/src/main/java/it/auties/whatsapp/model/companion/CompanionProperty.java b/src/main/java/it/auties/whatsapp/model/companion/CompanionProperty.java new file mode 100644 index 000000000..3c26adf49 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/companion/CompanionProperty.java @@ -0,0 +1,13 @@ +package it.auties.whatsapp.model.companion; + +/** + * A model that represents an immutable property associated with the linked device + * + * @param name the name of the property + * @param code an id that represents the property + * @param value the value associated with this property + * @param defaultValue the default value for this property + */ +public record CompanionProperty(String name, double code, Object value, Object defaultValue) { + +} diff --git a/src/main/java/it/auties/whatsapp/model/companion/CompanionSyncKey.java b/src/main/java/it/auties/whatsapp/model/companion/CompanionSyncKey.java new file mode 100644 index 000000000..e9c74f38b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/companion/CompanionSyncKey.java @@ -0,0 +1,18 @@ +package it.auties.whatsapp.model.companion; + +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.sync.AppStateSyncKey; + +import java.util.LinkedList; + +public record CompanionSyncKey( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Jid companion, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + LinkedList keys +) implements ProtobufMessage { + +} diff --git a/src/main/java/it/auties/whatsapp/model/contact/Contact.java b/src/main/java/it/auties/whatsapp/model/contact/Contact.java new file mode 100644 index 000000000..b0ba77f1b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/contact/Contact.java @@ -0,0 +1,181 @@ +package it.auties.whatsapp.model.contact; + +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.api.Whatsapp; +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.jid.JidProvider; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Objects; +import java.util.Optional; +import java.util.OptionalLong; + +/** + * A model class that represents a Contact. This class is only a model, this means that changing its + * values will have no real effect on WhatsappWeb's servers. + */ +public final class Contact implements JidProvider, ProtobufMessage { + /** + * The non-null unique jid used to identify this contact + */ + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + private final Jid jid; + + /** + * The nullable name specified by this contact when he created a Whatsapp account. Theoretically, + * it should not be possible for this field to be null as it's required when registering for + * Whatsapp. Though it looks that it can be removed later, so it's nullable. + */ + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + private String chosenName; + + /** + * The nullable name associated with this contact on the phone connected with Whatsapp + */ + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + private String fullName; + + /** + * The nullable short name associated with this contact on the phone connected with Whatsapp If a + * name is available, theoretically, also a short name should be + */ + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + private String shortName; + + /** + * The nullable last known presence of this contact. This field is associated only with the + * presence of this contact in the corresponding conversation. If, for example, this contact is + * composing, recording or paused in a group this field will not be affected. Instead, + * {@link Chat#presences()} should be used. By default, Whatsapp will not send updates about a + * contact's status unless they send a message or are in the recent contacts. To force Whatsapp to + * send updates, use {@link Whatsapp#subscribeToPresence(JidProvider)}. + */ + @ProtobufProperty(index = 5, type = ProtobufType.OBJECT) + private ContactStatus lastKnownPresence; + + /** + * The nullable last seconds this contact was seen available. Any contact can decide to hide this + * information in their privacy settings. + */ + @ProtobufProperty(index = 6, type = ProtobufType.UINT64) + private Long lastSeenSeconds; + + /** + * Whether this contact is blocked + */ + @ProtobufProperty(index = 7, type = ProtobufType.BOOL) + private boolean blocked; + + public Contact(Jid jid) { + this.jid = jid; + this.lastKnownPresence = ContactStatus.UNAVAILABLE; + } + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public Contact(Jid jid, String chosenName, String fullName, String shortName, ContactStatus lastKnownPresence, Long lastSeenSeconds, boolean blocked) { + this.jid = jid; + this.chosenName = chosenName; + this.fullName = fullName; + this.shortName = shortName; + this.lastKnownPresence = lastKnownPresence; + this.lastSeenSeconds = lastSeenSeconds; + this.blocked = blocked; + } + + public Jid jid() { + return this.jid; + } + + public String name() { + if (shortName != null) { + return shortName; + } + + if (fullName != null) { + return fullName; + } + + if (chosenName != null) { + return chosenName; + } + + return jid().user(); + } + + public OptionalLong lastSeenSeconds() { + return Clock.parseTimestamp(lastSeenSeconds); + } + + public Optional lastSeen() { + return Clock.parseSeconds(lastSeenSeconds); + } + + public Optional chosenName() { + return Optional.ofNullable(this.chosenName); + } + + public Optional fullName() { + return Optional.ofNullable(this.fullName); + } + + public Optional shortName() { + return Optional.ofNullable(this.shortName); + } + + public ContactStatus lastKnownPresence() { + return this.lastKnownPresence; + } + + public boolean blocked() { + return this.blocked; + } + + public Contact setChosenName(String chosenName) { + this.chosenName = chosenName; + return this; + } + + public Contact setFullName(String fullName) { + this.fullName = fullName; + return this; + } + + public Contact setShortName(String shortName) { + this.shortName = shortName; + return this; + } + + public Contact setLastKnownPresence(ContactStatus lastKnownPresence) { + this.lastKnownPresence = lastKnownPresence; + return this; + } + + public Contact setLastSeen(ZonedDateTime lastSeen) { + this.lastSeenSeconds = lastSeen.toEpochSecond(); + return this; + } + + public Contact setBlocked(boolean blocked) { + this.blocked = blocked; + return this; + } + + @Override + public int hashCode() { + return Objects.hashCode(this.jid()); + } + + public boolean equals(Object other) { + return other instanceof Contact that && Objects.equals(this.jid(), that.jid()); + } + + @Override + public Jid toJid() { + return jid(); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/contact/ContactCard.java b/src/main/java/it/auties/whatsapp/model/contact/ContactCard.java new file mode 100644 index 000000000..50581bfde --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/contact/ContactCard.java @@ -0,0 +1,161 @@ +package it.auties.whatsapp.model.contact; + +import ezvcard.Ezvcard; +import ezvcard.VCard; +import ezvcard.VCardVersion; +import ezvcard.property.SimpleProperty; +import ezvcard.property.Telephone; +import it.auties.protobuf.annotation.ProtobufConverter; +import it.auties.whatsapp.model.jid.Jid; + +import java.util.*; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import static it.auties.whatsapp.util.Specification.Whatsapp.*; + + +/** + * A model class to represent and build the vcard of a contact + */ +public sealed interface ContactCard { + @ProtobufConverter + static ContactCard ofNullable(String vcard) { + return vcard == null ? null : of(vcard); + } + + /** + * Parses a vcard + * If the vCard dependency wasn't included, or a parsing error occurs, a raw representation is returned + * + * @param vcard the non-null vcard to parse + * @return a non-null vcard + */ + static ContactCard of(String vcard) { + try { + var parsed = Ezvcard.parse(vcard).first(); + var version = Objects.requireNonNullElse(parsed.getVersion().getVersion(), VCardVersion.V3_0.getVersion()); + var name = Optional.ofNullable(parsed.getFormattedName().getValue()); + var phoneNumbers = parsed.getTelephoneNumbers() + .stream() + .filter(ContactCard::isValidPhoneNumber) + .collect(Collectors.toUnmodifiableMap(ContactCard::getPhoneType, ContactCard::getPhoneValue, ContactCard::joinPhoneNumbers)); + var businessName = Optional.ofNullable(parsed.getExtendedProperty(BUSINESS_NAME_VCARD_PROPERTY)) + .map(SimpleProperty::getValue); + return new Parsed(version, name, phoneNumbers, businessName); + } catch (Throwable ignored) { + return new Raw(vcard); + } + } + + /** + * Creates a new vcard + * + * @param name the nullable name of the contact + * @param phoneNumber the non-null phone number of the contact + * @return a vcard + */ + static ContactCard of(String name, Jid phoneNumber) { + return of(name, phoneNumber, null); + } + + /** + * Creates a new vcard + * + * @param name the nullable name of the contact + * @param phoneNumber the non-null phone number of the contact + * @param businessName the nullable business name of the contact + * @return a vcard + */ + static ContactCard of(String name, Jid phoneNumber, String businessName) { + return new Parsed( + VCardVersion.V3_0.getVersion(), + Optional.ofNullable(name), + new HashMap<>(Map.of(DEFAULT_NUMBER_VCARD_TYPE, List.of(Objects.requireNonNull(phoneNumber)))), + Optional.ofNullable(businessName) + ); + } + + private static boolean isValidPhoneNumber(Telephone entry) { + return getPhoneType(entry) != null && entry.getParameter(PHONE_NUMBER_VCARD_PROPERTY) != null; + } + + private static String getPhoneType(Telephone entry) { + return entry.getParameters().getType(); + } + + private static List getPhoneValue(Telephone entry) { + return List.of(Jid.of(entry.getParameter(PHONE_NUMBER_VCARD_PROPERTY))); + } + + private static List joinPhoneNumbers(List first, List second) { + return Stream.of(first, second).flatMap(Collection::stream).toList(); + } + + @ProtobufConverter + String toVcard(); + + /** + * A parsed representation of the vcard + */ + record Parsed( + String version, + Optional name, + Map> phoneNumbers, + Optional businessName + ) implements ContactCard { + public List defaultPhoneNumbers() { + return Objects.requireNonNullElseGet(phoneNumbers.get(DEFAULT_NUMBER_VCARD_TYPE), List::of); + } + + private void addPhoneNumber(VCard vcard, String type, Jid contact) { + var telephone = new Telephone(contact.toPhoneNumber()); + telephone.getParameters().setType(type); + telephone.getParameters().put(PHONE_NUMBER_VCARD_PROPERTY, contact.user()); + vcard.addTelephoneNumber(telephone); + } + + public void addPhoneNumber(Jid contact) { + addPhoneNumber(DEFAULT_NUMBER_VCARD_TYPE, contact); + } + + public void addPhoneNumber(String category, Jid contact) { + var oldValue = phoneNumbers.get(category); + if (oldValue == null) { + phoneNumbers.put(category, List.of(contact)); + return; + } + + var values = new ArrayList<>(oldValue); + values.add(contact); + phoneNumbers.put(category, Collections.unmodifiableList(values)); + } + + /** + * Converts this object in a valid vcard + * + * @return a non-null String + */ + @Override + @ProtobufConverter + public String toVcard() { + var vcard = new VCard(); + vcard.setVersion(VCardVersion.valueOfByStr(version())); + vcard.setFormattedName(name.orElse(null)); + phoneNumbers().forEach((type, contacts) -> contacts.forEach(contact -> addPhoneNumber(vcard, type, contact))); + businessName.ifPresent(value -> vcard.addExtendedProperty(BUSINESS_NAME_VCARD_PROPERTY, value)); + return Ezvcard.write(vcard).go(); + } + } + + /** + * A raw representation of the vcard + */ + record Raw(String toVcard) implements ContactCard { + @Override + @ProtobufConverter + public String toVcard() { + return toVcard; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/contact/ContactStatus.java b/src/main/java/it/auties/whatsapp/model/contact/ContactStatus.java new file mode 100644 index 000000000..caf4c3944 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/contact/ContactStatus.java @@ -0,0 +1,52 @@ +package it.auties.whatsapp.model.contact; + + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.model.ProtobufEnum; + +import java.util.Arrays; +import java.util.Optional; + +/** + * The constants of this enumerated type describe the various status that a {@link Contact} can be + * in + */ +public enum ContactStatus implements ProtobufEnum { + /** + * When the contact is online + */ + AVAILABLE(0), + /** + * When the contact is offline + */ + UNAVAILABLE(1), + /** + * When the contact is writing a text message + */ + COMPOSING(2), + /** + * When the contact is recording an audio message + */ + RECORDING(3); + + final int index; + + ContactStatus(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + + public static Optional of(String name) { + return Arrays.stream(values()) + .filter(entry -> entry.name().equalsIgnoreCase(name)) + .findFirst(); + } + + @Override + public String toString() { + return name().toLowerCase(); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/info/AdReplyInfo.java b/src/main/java/it/auties/whatsapp/model/info/AdReplyInfo.java new file mode 100644 index 000000000..6a312950b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/AdReplyInfo.java @@ -0,0 +1,57 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + + +/** + * A model class that holds the information related to an companion reply. + */ +@ProtobufMessageName("ContextInfo.AdReplyInfo") +public record AdReplyInfo( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String advertiserName, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + MediaType mediaType, + @ProtobufProperty(index = 16, type = ProtobufType.BYTES) + Optional thumbnail, + @ProtobufProperty(index = 17, type = ProtobufType.STRING) + Optional caption +) implements Info, ProtobufMessage { + + /** + * The constants of this enumerated type describe the various types of companion that a + * {@link AdReplyInfo} can link to + */ + @ProtobufMessageName("ContextInfo.AdReplyInfo.MediaType") + public enum MediaType implements ProtobufEnum { + /** + * Unknown type + */ + NONE(0), + /** + * Image type + */ + IMAGE(1), + /** + * Video type + */ + VIDEO(2); + + final int index; + + MediaType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/BusinessAccountLinkInfo.java b/src/main/java/it/auties/whatsapp/model/info/BusinessAccountLinkInfo.java new file mode 100644 index 000000000..ce0a5710e --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/BusinessAccountLinkInfo.java @@ -0,0 +1,86 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + +/** + * A model class that holds a payload about a business link info. + */ +@ProtobufMessageName("BizAccountLinkInfo") +public record BusinessAccountLinkInfo( + @ProtobufProperty(index = 1, type = ProtobufType.UINT64) + long businessId, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String phoneNumber, + @ProtobufProperty(index = 3, type = ProtobufType.UINT64) + long issueTimeSeconds, + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + HostStorageType hostStorage, + @ProtobufProperty(index = 5, type = ProtobufType.OBJECT) + AccountType accountType +) implements ProtobufMessage { + /** + * Returns this object's timestampSeconds + * + * @return an optional + */ + public Optional issueTime() { + return Clock.parseSeconds(issueTimeSeconds); + } + + /** + * The constants of this enumerated type describe the various types of business accounts + */ + @ProtobufMessageName("BizAccountLinkInfo.AccountType") + public enum AccountType implements ProtobufEnum { + /** + * Enterprise + */ + ENTERPRISE(0), + /** + * Page + */ + PAGE(1); + + final int index; + + AccountType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } + + @ProtobufMessageName("BizAccountLinkInfo.HostStorageType") + public enum HostStorageType implements ProtobufEnum { + /** + * Hosted on a private server ("On-Premise") + */ + ON_PREMISE(0), + + /** + * Hosted by facebook + */ + FACEBOOK(1); + + final int index; + + HostStorageType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/BusinessIdentityInfo.java b/src/main/java/it/auties/whatsapp/model/info/BusinessIdentityInfo.java new file mode 100644 index 000000000..8684624c6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/BusinessIdentityInfo.java @@ -0,0 +1,126 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.business.BusinessVerifiedNameCertificate; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + + +/** + * A model class that holds the information related to the identity of a business account. + */ +@ProtobufMessageName("BizIdentityInfo") +public record BusinessIdentityInfo( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + VerifiedLevel level, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + BusinessVerifiedNameCertificate certificate, + @ProtobufProperty(index = 3, type = ProtobufType.BOOL) + boolean signed, + @ProtobufProperty(index = 4, type = ProtobufType.BOOL) + boolean revoked, + @ProtobufProperty(index = 5, type = ProtobufType.OBJECT) + HostStorageType hostStorage, + @ProtobufProperty(index = 6, type = ProtobufType.OBJECT) + ActorsType actualActors, + @ProtobufProperty(index = 7, type = ProtobufType.UINT64) + long privacyModeTimestampSeconds, + @ProtobufProperty(index = 8, type = ProtobufType.UINT64) + long featureControls +) implements Info, ProtobufMessage { + /** + * Returns the privacy mode timestampSeconds + * + * @return an optional + */ + public Optional privacyModeTimestamp() { + return Clock.parseSeconds(privacyModeTimestampSeconds); + } + + /** + * The constants of this enumerated type describe the various types of actors of a business account + */ + @ProtobufMessageName("BizIdentityInfo.ActualActorsType") + public enum ActorsType implements ProtobufEnum { + /** + * Self + */ + SELF(0), + /** + * Bsp + */ + BSP(1); + + final int index; + + ActorsType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } + + /** + * The constants of this enumerated type describe the various types of verification that a business + * account can have + */ + @ProtobufMessageName("BizIdentityInfo.VerifiedLevelValue") + public enum VerifiedLevel implements ProtobufEnum { + /** + * Unknown + */ + UNKNOWN(0), + + /** + * Low + */ + LOW(1), + + /** + * High + */ + HIGH(2); + + final int index; + + VerifiedLevel(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } + + @ProtobufMessageName("BizIdentityInfo.HostStorageType") + public enum HostStorageType implements ProtobufEnum { + /** + * Hosted on a private server ("On-Premise") + */ + ON_PREMISE(0), + + /** + * Hosted by facebook + */ + FACEBOOK(1); + + final int index; + + HostStorageType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/ChatMessageInfo.java b/src/main/java/it/auties/whatsapp/model/info/ChatMessageInfo.java new file mode 100644 index 000000000..c73ee00a9 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/ChatMessageInfo.java @@ -0,0 +1,736 @@ +package it.auties.whatsapp.model.info; + +import com.fasterxml.jackson.annotation.JsonBackReference; +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.business.BusinessPrivacyStatus; +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.contact.Contact; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.media.MediaData; +import it.auties.whatsapp.model.message.model.*; +import it.auties.whatsapp.model.message.standard.LiveLocationMessage; +import it.auties.whatsapp.model.message.standard.ReactionMessage; +import it.auties.whatsapp.model.poll.PollAdditionalMetadata; +import it.auties.whatsapp.model.poll.PollUpdate; +import it.auties.whatsapp.model.sync.PhotoChange; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.*; + +import static java.util.Objects.requireNonNullElseGet; + +/** + * A model class that holds the information related to a {@link Message}. + */ +@ProtobufMessageName("WebMessageInfo") +public final class ChatMessageInfo implements MessageInfo, MessageStatusInfo, ProtobufMessage { + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + private final ChatMessageKey key; + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + private MessageContainer message; + @ProtobufProperty(index = 3, type = ProtobufType.UINT64) + private final long timestampSeconds; + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + private MessageStatus status; + @ProtobufProperty(index = 5, type = ProtobufType.STRING) + private final Jid senderJid; + @ProtobufProperty(index = 6, type = ProtobufType.UINT64) + private final long messageC2STimestamp; + @ProtobufProperty(index = 16, type = ProtobufType.BOOL) + private boolean ignore; + @ProtobufProperty(index = 17, type = ProtobufType.BOOL) + private boolean starred; + @ProtobufProperty(index = 18, type = ProtobufType.BOOL) + private final boolean broadcast; + @ProtobufProperty(index = 19, type = ProtobufType.STRING) + private final String pushName; + @ProtobufProperty(index = 20, type = ProtobufType.BYTES) + private final byte[] mediaCiphertextSha256; + @ProtobufProperty(index = 21, type = ProtobufType.BOOL) + private final boolean multicast; + @ProtobufProperty(index = 22, type = ProtobufType.BOOL) + private final boolean urlText; + @ProtobufProperty(index = 23, type = ProtobufType.BOOL) + private final boolean urlNumber; + @ProtobufProperty(index = 24, type = ProtobufType.OBJECT) + private final StubType stubType; + @ProtobufProperty(index = 25, type = ProtobufType.BOOL) + private final boolean clearMedia; + @ProtobufProperty(index = 26, type = ProtobufType.STRING) + private final List stubParameters; + @ProtobufProperty(index = 27, type = ProtobufType.UINT32) + private final int duration; + @ProtobufProperty(index = 28, type = ProtobufType.STRING) + private final List labels; + @ProtobufProperty(index = 29, type = ProtobufType.OBJECT) + private final PaymentInfo paymentInfo; + @ProtobufProperty(index = 30, type = ProtobufType.OBJECT) + private final LiveLocationMessage finalLiveLocation; + @ProtobufProperty(index = 31, type = ProtobufType.OBJECT) + private final PaymentInfo quotedPaymentInfo; + @ProtobufProperty(index = 32, type = ProtobufType.UINT64) + private final long ephemeralStartTimestamp; + @ProtobufProperty(index = 33, type = ProtobufType.UINT32) + private final int ephemeralDuration; + @ProtobufProperty(index = 34, type = ProtobufType.BOOL) + private final boolean enableEphemeral; + @ProtobufProperty(index = 35, type = ProtobufType.BOOL) + private final boolean ephemeralOutOfSync; + @ProtobufProperty(index = 36, type = ProtobufType.OBJECT) + private final BusinessPrivacyStatus businessPrivacyStatus; + @ProtobufProperty(index = 37, type = ProtobufType.STRING) + private final String businessVerifiedName; + @ProtobufProperty(index = 38, type = ProtobufType.OBJECT) + private final MediaData mediaData; + @ProtobufProperty(index = 39, type = ProtobufType.OBJECT) + private final PhotoChange photoChange; + @ProtobufProperty(index = 40, type = ProtobufType.OBJECT) + private final MessageReceipt receipt; + @ProtobufProperty(index = 41, type = ProtobufType.OBJECT) + private final List reactions; + @ProtobufProperty(index = 42, type = ProtobufType.OBJECT) + private final MediaData quotedStickerData; + @ProtobufProperty(index = 43, type = ProtobufType.BYTES) + private final byte[] futureProofData; + @ProtobufProperty(index = 44, type = ProtobufType.OBJECT) + private final PublicServiceAnnouncementStatus psaStatus; + @ProtobufProperty(index = 45, type = ProtobufType.OBJECT) + private final List pollUpdates; + @ProtobufProperty(index = 46, type = ProtobufType.OBJECT) + private PollAdditionalMetadata pollAdditionalMetadata; + @ProtobufProperty(index = 47, type = ProtobufType.STRING) + private final String agentId; + @ProtobufProperty(index = 48, type = ProtobufType.BOOL) + private final boolean statusAlreadyViewed; + @ProtobufProperty(index = 49, type = ProtobufType.BYTES) + private byte[] messageSecret; + @ProtobufProperty(index = 50, type = ProtobufType.OBJECT) + private final KeepInChat keepInChat; + @ProtobufProperty(index = 51, type = ProtobufType.STRING) + private final Jid originalSender; + @ProtobufProperty(index = 52, type = ProtobufType.UINT64) + private long revokeTimestampSeconds; + @JsonBackReference + private Chat chat; + + private Contact sender; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public ChatMessageInfo(ChatMessageKey key, MessageContainer message, long timestampSeconds, MessageStatus status, Jid senderJid, long messageC2STimestamp, boolean ignore, boolean starred, boolean broadcast, String pushName, byte[] mediaCiphertextSha256, boolean multicast, boolean urlText, boolean urlNumber, StubType stubType, boolean clearMedia, List stubParameters, int duration, List labels, PaymentInfo paymentInfo, LiveLocationMessage finalLiveLocation, PaymentInfo quotedPaymentInfo, long ephemeralStartTimestamp, int ephemeralDuration, boolean enableEphemeral, boolean ephemeralOutOfSync, BusinessPrivacyStatus businessPrivacyStatus, String businessVerifiedName, MediaData mediaData, PhotoChange photoChange, MessageReceipt receipt, List reactions, MediaData quotedStickerData, byte[] futureProofData, PublicServiceAnnouncementStatus psaStatus, List pollUpdates, PollAdditionalMetadata pollAdditionalMetadata, String agentId, boolean statusAlreadyViewed, byte[] messageSecret, KeepInChat keepInChat, Jid originalSender, long revokeTimestampSeconds, Chat chat, Contact sender) { + this.key = key; + this.message = message; + this.timestampSeconds = timestampSeconds; + this.status = status; + this.senderJid = senderJid; + this.messageC2STimestamp = messageC2STimestamp; + this.ignore = ignore; + this.starred = starred; + this.broadcast = broadcast; + this.pushName = pushName; + this.mediaCiphertextSha256 = mediaCiphertextSha256; + this.multicast = multicast; + this.urlText = urlText; + this.urlNumber = urlNumber; + this.stubType = stubType; + this.clearMedia = clearMedia; + this.stubParameters = stubParameters; + this.duration = duration; + this.labels = labels; + this.paymentInfo = paymentInfo; + this.finalLiveLocation = finalLiveLocation; + this.quotedPaymentInfo = quotedPaymentInfo; + this.ephemeralStartTimestamp = ephemeralStartTimestamp; + this.ephemeralDuration = ephemeralDuration; + this.enableEphemeral = enableEphemeral; + this.ephemeralOutOfSync = ephemeralOutOfSync; + this.businessPrivacyStatus = businessPrivacyStatus; + this.businessVerifiedName = businessVerifiedName; + this.mediaData = mediaData; + this.photoChange = photoChange; + this.receipt = receipt; + this.reactions = reactions; + this.quotedStickerData = quotedStickerData; + this.futureProofData = futureProofData; + this.psaStatus = psaStatus; + this.pollUpdates = pollUpdates; + this.pollAdditionalMetadata = pollAdditionalMetadata; + this.agentId = agentId; + this.statusAlreadyViewed = statusAlreadyViewed; + this.messageSecret = messageSecret; + this.keepInChat = keepInChat; + this.originalSender = originalSender; + this.revokeTimestampSeconds = revokeTimestampSeconds; + this.chat = chat; + this.sender = sender; + } + + + public ChatMessageInfo(ChatMessageKey key, MessageContainer message, long timestampSeconds, MessageStatus status, Jid senderJid, long messageC2STimestamp, boolean ignore, boolean starred, boolean broadcast, String pushName, byte[] mediaCiphertextSha256, boolean multicast, boolean urlText, boolean urlNumber, StubType stubType, boolean clearMedia, List stubParameters, int duration, List labels, PaymentInfo paymentInfo, LiveLocationMessage finalLiveLocation, PaymentInfo quotedPaymentInfo, long ephemeralStartTimestamp, int ephemeralDuration, boolean enableEphemeral, boolean ephemeralOutOfSync, BusinessPrivacyStatus businessPrivacyStatus, String businessVerifiedName, MediaData mediaData, PhotoChange photoChange, MessageReceipt receipt, List reactions, MediaData quotedStickerData, byte[] futureProofData, PublicServiceAnnouncementStatus psaStatus, List pollUpdates, PollAdditionalMetadata pollAdditionalMetadata, String agentId, boolean statusAlreadyViewed, byte[] messageSecret, KeepInChat keepInChat, Jid originalSender, long revokeTimestampSeconds) { + this.key = key; + this.message = Objects.requireNonNullElseGet(message, MessageContainer::empty); + this.timestampSeconds = timestampSeconds; + this.status = status; + this.senderJid = senderJid; + this.messageC2STimestamp = messageC2STimestamp; + this.ignore = ignore; + this.starred = starred; + this.broadcast = broadcast; + this.pushName = pushName; + this.mediaCiphertextSha256 = mediaCiphertextSha256; + this.multicast = multicast; + this.urlText = urlText; + this.urlNumber = urlNumber; + this.stubType = stubType; + this.clearMedia = clearMedia; + this.stubParameters = stubParameters; + this.duration = duration; + this.labels = labels; + this.paymentInfo = paymentInfo; + this.finalLiveLocation = finalLiveLocation; + this.quotedPaymentInfo = quotedPaymentInfo; + this.ephemeralStartTimestamp = ephemeralStartTimestamp; + this.ephemeralDuration = ephemeralDuration; + this.enableEphemeral = enableEphemeral; + this.ephemeralOutOfSync = ephemeralOutOfSync; + this.businessPrivacyStatus = businessPrivacyStatus; + this.businessVerifiedName = businessVerifiedName; + this.mediaData = mediaData; + this.photoChange = photoChange; + this.receipt = Objects.requireNonNullElseGet(receipt, MessageReceipt::new); + this.reactions = reactions; + this.quotedStickerData = quotedStickerData; + this.futureProofData = futureProofData; + this.psaStatus = psaStatus; + this.pollUpdates = pollUpdates; + this.pollAdditionalMetadata = pollAdditionalMetadata; + this.agentId = agentId; + this.statusAlreadyViewed = statusAlreadyViewed; + this.messageSecret = messageSecret; + this.keepInChat = keepInChat; + this.originalSender = originalSender; + this.revokeTimestampSeconds = revokeTimestampSeconds; + } + + /** + * Determines whether the message was sent by you or by someone else + * + * @return a boolean + */ + public boolean fromMe() { + return key.fromMe(); + } + + /** + * Returns the name of the chat where this message is or its pretty jid + * + * @return a non-null String + */ + public String chatName() { + if (chat != null) { + return chat.name(); + } + + return chatJid().user(); + } + + /** + * Returns the jid of the contact or group that sent the message. + * + * @return a non-null ContactJid + */ + public Jid chatJid() { + return key.chatJid(); + } + + /** + * Returns the name of the person that sent this message or its pretty jid + * + * @return a non-null String + */ + public String senderName() { + return sender().map(Contact::name).orElseGet(senderJid()::user); + } + + /** + * Returns the message quoted by this message + * + * @return a non-empty optional {@link ChatMessageInfo} if this message quotes a message in memory + */ + public Optional quotedMessage() { + return Optional.of(message) + .flatMap(MessageContainer::contentWithContext) + .flatMap(ContextualMessage::contextInfo) + .flatMap(QuotedMessageInfo::of); + } + + /** + * Returns the timestampSeconds for this message + * + * @return an optional + */ + public Optional timestamp() { + return Clock.parseSeconds(timestampSeconds); + } + + /** + * Returns the timestampSeconds for this message + * + * @return an optional + */ + public Optional revokeTimestamp() { + return Clock.parseSeconds(revokeTimestampSeconds); + } + + @Override + public int hashCode() { + return Objects.hashCode(id()); + } + + public boolean equals(Object object) { + return object instanceof ChatMessageInfo that + && Objects.equals(this.id(), that.id()) + && Objects.equals(this.stubType, that.stubType); + } + + /** + * Returns the id of the message + * + * @return a non-null String + */ + public String id() { + return key.id(); + } + + /** + * Returns the jid of the sender + * + * @return a non-null ContactJid + */ + public Jid senderJid() { + return requireNonNullElseGet(senderJid, () -> key.senderJid().orElseGet(key::chatJid)); + } + + @Override + public Jid parentJid() { + return chatJid(); + } + + public ChatMessageKey key() { + return key; + } + + @Override + public MessageContainer message() { + return message; + } + + public ChatMessageInfo setMessage(MessageContainer message) { + this.message = message; + return this; + } + + public OptionalLong timestampSeconds() { + return Clock.parseTimestamp(timestampSeconds); + } + + @Override + public MessageStatus status() { + return status; + } + + public long messageC2STimestamp() { + return messageC2STimestamp; + } + + public boolean ignore() { + return ignore; + } + + public ChatMessageInfo setIgnore(boolean ignore) { + this.ignore = ignore; + return this; + } + + public boolean starred() { + return starred; + } + + public boolean broadcast() { + return broadcast; + } + + public Optional pushName() { + return Optional.ofNullable(pushName); + } + + public Optional mediaCiphertextSha256() { + return Optional.ofNullable(mediaCiphertextSha256); + } + + public boolean multicast() { + return multicast; + } + + public boolean urlText() { + return urlText; + } + + public boolean urlNumber() { + return urlNumber; + } + + public Optional stubType() { + return Optional.ofNullable(stubType); + } + + public boolean clearMedia() { + return clearMedia; + } + + public List stubParameters() { + return stubParameters; + } + + public int duration() { + return duration; + } + + public List labels() { + return labels; + } + + public Optional paymentInfo() { + return Optional.ofNullable(paymentInfo); + } + + public Optional finalLiveLocation() { + return Optional.ofNullable(finalLiveLocation); + } + + public Optional quotedPaymentInfo() { + return Optional.ofNullable(quotedPaymentInfo); + } + + public long ephemeralStartTimestamp() { + return ephemeralStartTimestamp; + } + + public int ephemeralDuration() { + return ephemeralDuration; + } + + public boolean enableEphemeral() { + return enableEphemeral; + } + + public boolean ephemeralOutOfSync() { + return ephemeralOutOfSync; + } + + public Optional businessPrivacyStatus() { + return Optional.ofNullable(businessPrivacyStatus); + } + + public Optional businessVerifiedName() { + return Optional.ofNullable(businessVerifiedName); + } + + public Optional mediaData() { + return Optional.ofNullable(mediaData); + } + + public Optional photoChange() { + return Optional.ofNullable(photoChange); + } + + public MessageReceipt receipt() { + return receipt; + } + + public List reactions() { + return reactions; + } + + public Optional quotedStickerData() { + return Optional.ofNullable(quotedStickerData); + } + + public byte[] futureProofData() { + return futureProofData; + } + + public Optional psaStatus() { + return Optional.ofNullable(psaStatus); + } + + public List pollUpdates() { + return pollUpdates; + } + + public Optional pollAdditionalMetadata() { + return Optional.ofNullable(pollAdditionalMetadata); + } + + public ChatMessageInfo setPollAdditionalMetadata(PollAdditionalMetadata pollAdditionalMetadata) { + this.pollAdditionalMetadata = pollAdditionalMetadata; + return this; + } + + public Optional agentId() { + return Optional.ofNullable(agentId); + } + + public boolean statusAlreadyViewed() { + return statusAlreadyViewed; + } + + public Optional messageSecret() { + return Optional.ofNullable(messageSecret); + } + + public ChatMessageInfo setMessageSecret(byte[] messageSecret) { + this.messageSecret = messageSecret; + return this; + } + + public Optional keepInChat() { + return Optional.ofNullable(keepInChat); + } + + public Optional originalSender() { + return Optional.ofNullable(originalSender); + } + + public long revokeTimestampSeconds() { + return revokeTimestampSeconds; + } + + public Optional chat() { + return Optional.ofNullable(chat); + } + + public ChatMessageInfo setChat(Chat chat) { + this.chat = chat; + return this; + } + + public Optional sender() { + return Optional.ofNullable(sender); + } + + public ChatMessageInfo setSender(Contact sender) { + this.sender = sender; + return this; + } + + @Override + public ChatMessageInfo setStatus(MessageStatus status) { + this.status = status; + return this; + } + + public ChatMessageInfo setStarred(boolean starred) { + this.starred = starred; + return this; + } + + public ChatMessageInfo setRevokeTimestampSeconds(long revokeTimestampSeconds) { + this.revokeTimestampSeconds = revokeTimestampSeconds; + return this; + } + + /** + * The constants of this enumerated type describe the various types of server message that a {@link ChatMessageInfo} can describe + */ + public enum StubType implements ProtobufEnum { + UNKNOWN(0, List.of("unknown")), + REVOKE(1, List.of("revoked")), + CIPHERTEXT(2, List.of("ciphertext")), + FUTUREPROOF(3, List.of("phone")), + NON_VERIFIED_TRANSITION(4, List.of("non_verified_transition")), + UNVERIFIED_TRANSITION(5, List.of("unverified_transition")), + VERIFIED_TRANSITION(6, List.of("verified_transition")), + VERIFIED_LOW_UNKNOWN(7, List.of("verified_low_unknown")), + VERIFIED_HIGH(8, List.of("verified_high")), + VERIFIED_INITIAL_UNKNOWN(9, List.of("verified_initial_unknown")), + VERIFIED_INITIAL_LOW(10, List.of("verified_initial_low")), + VERIFIED_INITIAL_HIGH(11, List.of("verified_initial_high")), + VERIFIED_TRANSITION_ANY_TO_NONE(12, List.of("verified_transition_any_to_none")), + VERIFIED_TRANSITION_ANY_TO_HIGH(13, List.of("verified_transition_any_to_high")), + VERIFIED_TRANSITION_HIGH_TO_LOW(14, List.of("verified_transition_high_to_low")), + VERIFIED_TRANSITION_HIGH_TO_UNKNOWN(15, List.of("verified_transition_high_to_unknown")), + VERIFIED_TRANSITION_UNKNOWN_TO_LOW(16, List.of("verified_transition_unknown_to_low")), + VERIFIED_TRANSITION_LOW_TO_UNKNOWN(17, List.of("verified_transition_low_to_unknown")), + VERIFIED_TRANSITION_NONE_TO_LOW(18, List.of("verified_transition_none_to_low")), + VERIFIED_TRANSITION_NONE_TO_UNKNOWN(19, List.of("verified_transition_none_to_unknown")), + GROUP_CREATE(20, List.of("create")), + GROUP_CHANGE_SUBJECT(21, List.of("subject")), + GROUP_CHANGE_ICON(22, List.of("picture")), + GROUP_CHANGE_INVITE_LINK(23, List.of("revoke_invite")), + GROUP_CHANGE_DESCRIPTION(24, List.of("description")), + GROUP_CHANGE_RESTRICT(25, List.of("restrict", "locked", "unlocked")), + GROUP_CHANGE_ANNOUNCE(26, List.of("announce", "announcement", "not_announcement")), + GROUP_PARTICIPANT_ADD(27, List.of("add")), + GROUP_PARTICIPANT_REMOVE(28, List.of("remove")), + GROUP_PARTICIPANT_PROMOTE(29, List.of("promote")), + GROUP_PARTICIPANT_DEMOTE(30, List.of("demote")), + GROUP_PARTICIPANT_INVITE(31, List.of("invite")), + GROUP_PARTICIPANT_LEAVE(32, List.of("leave")), + GROUP_PARTICIPANT_CHANGE_NUMBER(33, List.of("modify")), + BROADCAST_CREATE(34, List.of("create")), + BROADCAST_ADD(35, List.of("add")), + BROADCAST_REMOVE(36, List.of("remove")), + GENERIC_NOTIFICATION(37, List.of("notification")), + E2E_IDENTITY_CHANGED(38, List.of("identity")), + E2E_ENCRYPTED(39, List.of("encrypt")), + CALL_MISSED_VOICE(40, List.of("miss")), + CALL_MISSED_VIDEO(41, List.of("miss_video")), + INDIVIDUAL_CHANGE_NUMBER(42, List.of("change_number")), + GROUP_DELETE(43, List.of("delete")), + GROUP_ANNOUNCE_MODE_MESSAGE_BOUNCE(44, List.of("announce_msg_bounce")), + CALL_MISSED_GROUP_VOICE(45, List.of("miss_group")), + CALL_MISSED_GROUP_VIDEO(46, List.of("miss_group_video")), + PAYMENT_CIPHERTEXT(47, List.of("ciphertext")), + PAYMENT_FUTUREPROOF(48, List.of("futureproof")), + PAYMENT_TRANSACTION_STATUS_UPDATE_FAILED(49, List.of("payment_transaction_status_update_failed")), + PAYMENT_TRANSACTION_STATUS_UPDATE_REFUNDED(50, List.of("payment_transaction_status_update_refunded")), + PAYMENT_TRANSACTION_STATUS_UPDATE_REFUND_FAILED(51, List.of("payment_transaction_status_update_refund_failed")), + PAYMENT_TRANSACTION_STATUS_RECEIVER_PENDING_SETUP(52, List.of("payment_transaction_status_receiver_pending_setup")), + PAYMENT_TRANSACTION_STATUS_RECEIVER_SUCCESS_AFTER_HICCUP(53, List.of("payment_transaction_status_receiver_success_after_hiccup")), + PAYMENT_ACTION_ACCOUNT_SETUP_REMINDER(54, List.of("payment_action_account_setup_reminder")), + PAYMENT_ACTION_SEND_PAYMENT_REMINDER(55, List.of("payment_action_send_payment_reminder")), + PAYMENT_ACTION_SEND_PAYMENT_INVITATION(56, List.of("payment_action_send_payment_invitation")), + PAYMENT_ACTION_REQUEST_DECLINED(57, List.of("payment_action_request_declined")), + PAYMENT_ACTION_REQUEST_EXPIRED(58, List.of("payment_action_request_expired")), + PAYMENT_ACTION_REQUEST_CANCELLED(59, List.of("payment_transaction_request_cancelled")), + BIZ_VERIFIED_TRANSITION_TOP_TO_BOTTOM(60, List.of("biz_verified_transition_top_to_bottom")), + BIZ_VERIFIED_TRANSITION_BOTTOM_TO_TOP(61, List.of("biz_verified_transition_bottom_to_top")), + BIZ_INTRO_TOP(62, List.of("biz_intro_top")), + BIZ_INTRO_BOTTOM(63, List.of("biz_intro_bottom")), + BIZ_NAME_CHANGE(64, List.of("biz_name_change")), + BIZ_MOVE_TO_CONSUMER_APP(65, List.of("biz_move_to_consumer_app")), + BIZ_TWO_TIER_MIGRATION_TOP(66, List.of("biz_two_tier_migration_top")), + BIZ_TWO_TIER_MIGRATION_BOTTOM(67, List.of("biz_two_tier_migration_bottom")), + OVERSIZED(68, List.of("oversized")), + GROUP_CHANGE_NO_FREQUENTLY_FORWARDED(69, List.of("frequently_forwarded_ok", "no_frequently_forwarded")), + GROUP_V4_ADD_INVITE_SENT(70, List.of("v4_add_invite_sent")), + GROUP_PARTICIPANT_ADD_REQUEST_JOIN(71, List.of("v4_add_invite_join")), + CHANGE_EPHEMERAL_SETTING(72, List.of("ephemeral", "not_ephemeral")), + E2E_DEVICE_CHANGED(73, List.of("device")), + VIEWED_ONCE(74, List.of()), + E2E_ENCRYPTED_NOW(75, List.of("encrypt_now")), + BLUE_MSG_BSP_FB_TO_BSP_PREMISE(76, List.of("blue_msg_bsp_fb_to_bsp_premise")), + BLUE_MSG_BSP_FB_TO_SELF_FB(77, List.of("blue_msg_bsp_fb_to_self_fb")), + BLUE_MSG_BSP_FB_TO_SELF_PREMISE(78, List.of("blue_msg_bsp_fb_to_self_premise")), + BLUE_MSG_BSP_FB_UNVERIFIED(79, List.of("blue_msg_bsp_fb_unverified")), + BLUE_MSG_BSP_FB_UNVERIFIED_TO_SELF_PREMISE_VERIFIED(80, List.of("blue_msg_bsp_fb_unverified_to_self_premise_verified")), + BLUE_MSG_BSP_FB_VERIFIED(81, List.of("blue_msg_bsp_fb_verified")), + BLUE_MSG_BSP_FB_VERIFIED_TO_SELF_PREMISE_UNVERIFIED(82, List.of("blue_msg_bsp_fb_verified_to_self_premise_unverified")), + BLUE_MSG_BSP_PREMISE_TO_SELF_PREMISE(83, List.of("blue_msg_bsp_premise_to_self_premise")), + BLUE_MSG_BSP_PREMISE_UNVERIFIED(84, List.of("blue_msg_bsp_premise_unverified")), + BLUE_MSG_BSP_PREMISE_UNVERIFIED_TO_SELF_PREMISE_VERIFIED(85, List.of("blue_msg_bsp_premise_unverified_to_self_premise_verified")), + BLUE_MSG_BSP_PREMISE_VERIFIED(86, List.of("blue_msg_bsp_premise_verified")), + BLUE_MSG_BSP_PREMISE_VERIFIED_TO_SELF_PREMISE_UNVERIFIED(87, List.of("blue_msg_bsp_premise_verified_to_self_premise_unverified")), + BLUE_MSG_CONSUMER_TO_BSP_FB_UNVERIFIED(88, List.of("blue_msg_consumer_to_bsp_fb_unverified")), + BLUE_MSG_CONSUMER_TO_BSP_PREMISE_UNVERIFIED(89, List.of("blue_msg_consumer_to_bsp_premise_unverified")), + BLUE_MSG_CONSUMER_TO_SELF_FB_UNVERIFIED(90, List.of("blue_msg_consumer_to_self_fb_unverified")), + BLUE_MSG_CONSUMER_TO_SELF_PREMISE_UNVERIFIED(91, List.of("blue_msg_consumer_to_self_premise_unverified")), + BLUE_MSG_SELF_FB_TO_BSP_PREMISE(92, List.of("blue_msg_self_fb_to_bsp_premise")), + BLUE_MSG_SELF_FB_TO_SELF_PREMISE(93, List.of("blue_msg_self_fb_to_self_premise")), + BLUE_MSG_SELF_FB_UNVERIFIED(94, List.of("blue_msg_self_fb_unverified")), + BLUE_MSG_SELF_FB_UNVERIFIED_TO_SELF_PREMISE_VERIFIED(95, List.of("blue_msg_self_fb_unverified_to_self_premise_verified")), + BLUE_MSG_SELF_FB_VERIFIED(96, List.of("blue_msg_self_fb_verified")), + BLUE_MSG_SELF_FB_VERIFIED_TO_SELF_PREMISE_UNVERIFIED(97, List.of("blue_msg_self_fb_verified_to_self_premise_unverified")), + BLUE_MSG_SELF_PREMISE_TO_BSP_PREMISE(98, List.of("blue_msg_self_premise_to_bsp_premise")), + BLUE_MSG_SELF_PREMISE_UNVERIFIED(99, List.of("blue_msg_self_premise_unverified")), + BLUE_MSG_SELF_PREMISE_VERIFIED(100, List.of("blue_msg_self_premise_verified")), + BLUE_MSG_TO_BSP_FB(101, List.of("blue_msg_to_bsp_fb")), + BLUE_MSG_TO_CONSUMER(102, List.of("blue_msg_to_consumer")), + BLUE_MSG_TO_SELF_FB(103, List.of("blue_msg_to_self_fb")), + BLUE_MSG_UNVERIFIED_TO_BSP_FB_VERIFIED(104, List.of("blue_msg_unverified_to_bsp_fb_verified")), + BLUE_MSG_UNVERIFIED_TO_BSP_PREMISE_VERIFIED(105, List.of("blue_msg_unverified_to_bsp_premise_verified")), + BLUE_MSG_UNVERIFIED_TO_SELF_FB_VERIFIED(106, List.of("blue_msg_unverified_to_self_fb_verified")), + BLUE_MSG_UNVERIFIED_TO_VERIFIED(107, List.of("blue_msg_unverified_to_verified")), + BLUE_MSG_VERIFIED_TO_BSP_FB_UNVERIFIED(108, List.of("blue_msg_verified_to_bsp_fb_unverified")), + BLUE_MSG_VERIFIED_TO_BSP_PREMISE_UNVERIFIED(109, List.of("blue_msg_verified_to_bsp_premise_unverified")), + BLUE_MSG_VERIFIED_TO_SELF_FB_UNVERIFIED(110, List.of("blue_msg_verified_to_self_fb_unverified")), + BLUE_MSG_VERIFIED_TO_UNVERIFIED(111, List.of("blue_msg_verified_to_unverified")), + BLUE_MSG_BSP_FB_UNVERIFIED_TO_BSP_PREMISE_VERIFIED(112, List.of("blue_msg_bsp_fb_unverified_to_bsp_premise_verified")), + BLUE_MSG_BSP_FB_UNVERIFIED_TO_SELF_FB_VERIFIED(113, List.of("blue_msg_bsp_fb_unverified_to_self_fb_verified")), + BLUE_MSG_BSP_FB_VERIFIED_TO_BSP_PREMISE_UNVERIFIED(114, List.of("blue_msg_bsp_fb_verified_to_bsp_premise_unverified")), + BLUE_MSG_BSP_FB_VERIFIED_TO_SELF_FB_UNVERIFIED(115, List.of("blue_msg_bsp_fb_verified_to_self_fb_unverified")), + BLUE_MSG_SELF_FB_UNVERIFIED_TO_BSP_PREMISE_VERIFIED(116, List.of("blue_msg_self_fb_unverified_to_bsp_premise_verified")), + BLUE_MSG_SELF_FB_VERIFIED_TO_BSP_PREMISE_UNVERIFIED(117, List.of("blue_msg_self_fb_verified_to_bsp_premise_unverified")), + E2E_IDENTITY_UNAVAILABLE(118, List.of("e2e_identity_unavailable")), + GROUP_CREATING(119, List.of()), + GROUP_CREATE_FAILED(120, List.of()), + GROUP_BOUNCED(121, List.of()), + BLOCK_CONTACT(122, List.of("block_contact")), + EPHEMERAL_SETTING_NOT_APPLIED(123, List.of()), + SYNC_FAILED(124, List.of()), + SYNCING(125, List.of()), + BIZ_PRIVACY_MODE_INIT_FB(126, List.of("biz_privacy_mode_init_fb")), + BIZ_PRIVACY_MODE_INIT_BSP(127, List.of("biz_privacy_mode_init_bsp")), + BIZ_PRIVACY_MODE_TO_FB(128, List.of("biz_privacy_mode_to_fb")), + BIZ_PRIVACY_MODE_TO_BSP(129, List.of("biz_privacy_mode_to_bsp")), + DISAPPEARING_MODE(130, List.of("disappearing_mode")), + E2E_DEVICE_FETCH_FAILED(131, List.of()), + ADMIN_REVOKE(132, List.of("admin")), + GROUP_INVITE_LINK_GROWTH_LOCKED(133, List.of("growth_locked", "growth_unlocked")), + COMMUNITY_LINK_PARENT_GROUP(134, List.of("parent_group_link")), + COMMUNITY_LINK_SIBLING_GROUP(135, List.of("sibling_group_link")), + COMMUNITY_LINK_SUB_GROUP(136, List.of("sub_group_link", "link")), + COMMUNITY_UNLINK_PARENT_GROUP(137, List.of("parent_group_unlink")), + COMMUNITY_UNLINK_SIBLING_GROUP(138, List.of("sibling_group_unlink")), + COMMUNITY_UNLINK_SUB_GROUP(139, List.of("sub_group_unlink", "unlink")), + GROUP_PARTICIPANT_ACCEPT(140, List.of()), + GROUP_PARTICIPANT_LINKED_GROUP_JOIN(141, List.of("linked_group_join")), + COMMUNITY_CREATE(142, List.of("community_create")), + EPHEMERAL_KEEP_IN_CHAT(143, List.of("ephemeral_keep_in_chat")), + GROUP_MEMBERSHIP_JOIN_APPROVAL_REQUEST(144, List.of("membership_approval_request")), + GROUP_MEMBERSHIP_JOIN_APPROVAL_MODE(145, List.of("membership_approval_mode")), + INTEGRITY_UNLINK_PARENT_GROUP(146, List.of("integrity_parent_group_unlink")), + COMMUNITY_PARTICIPANT_PROMOTE(147, List.of("linked_group_promote")), + COMMUNITY_PARTICIPANT_DEMOTE(148, List.of("linked_group_demote")), + COMMUNITY_PARENT_GROUP_DELETED(149, List.of("delete_parent_group")), + COMMUNITY_LINK_PARENT_GROUP_MEMBERSHIP_APPROVAL(150, List.of("parent_group_link_membership_approval")), + GROUP_PARTICIPANT_JOINED_GROUP_AND_PARENT_GROUP(151, List.of("auto_add")), + MASKED_THREAD_CREATED(152, List.of("masked_thread_created")), + MASKED_THREAD_UNMASKED(153, List.of()), + BIZ_CHAT_ASSIGNMENT(154, List.of("chat_assignment")), + CHAT_PSA(155, List.of("e2e_notification")), + CHAT_POLL_CREATION_MESSAGE(156, List.of()), + CAG_MASKED_THREAD_CREATED(157, List.of("cag_masked_thread_created")), + COMMUNITY_PARENT_GROUP_SUBJECT_CHANGED(158, List.of("subject")), + CAG_INVITE_AUTO_ADD(159, List.of("invite_auto_add")), + BIZ_CHAT_ASSIGNMENT_UNASSIGN(160, List.of("chat_assignment_unassign")), + CAG_INVITE_AUTO_JOINED(161, List.of("invite_auto_add")); + + final int index; + private final List symbols; + + StubType(@ProtobufEnumIndex int index, List symbols) { + this.index = index; + this.symbols = symbols; + } + + public int index() { + return index; + } + + public List symbols() { + return symbols; + } + + public static Optional of(String symbol) { + return Arrays.stream(values()).filter(entry -> entry.symbols().contains(symbol)).findFirst(); + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/ContextInfo.java b/src/main/java/it/auties/whatsapp/model/info/ContextInfo.java new file mode 100644 index 000000000..09f194377 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/ContextInfo.java @@ -0,0 +1,404 @@ +package it.auties.whatsapp.model.info; + +import com.fasterxml.jackson.annotation.JsonBackReference; +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.base.ButtonActionLink; +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.chat.ChatDisappear; +import it.auties.whatsapp.model.contact.Contact; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.message.model.ChatMessageKey; +import it.auties.whatsapp.model.message.model.MessageContainer; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; + +/** + * A model class that holds the information related to a {@link it.auties.whatsapp.model.message.model.ContextualMessage}. + */ +@ProtobufMessageName("ContextInfo") +public final class ContextInfo implements Info, ProtobufMessage { + /** + * The jid of the message that this ContextualMessage quotes + */ + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + private final String quotedMessageId; + + /** + * The jid of the contact that sent the message that this ContextualMessage quotes + */ + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + private final Jid quotedMessageSenderJid; + + /** + * The message container that this ContextualMessage quotes + */ + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + private final MessageContainer quotedMessage; + + /** + * The jid of the contact that sent the message that this ContextualMessage quotes + */ + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + private final Jid quotedMessageChatJid; + + /** + * A list of the contacts' jids mentioned in this ContextualMessage + */ + @ProtobufProperty(index = 15, type = ProtobufType.STRING) + private final List mentions; + + /** + * Conversation source + */ + @ProtobufProperty(index = 18, type = ProtobufType.STRING) + private final String conversionSource; + + /** + * Conversation data + */ + @ProtobufProperty(index = 19, type = ProtobufType.BYTES) + private final byte[] conversionData; + + /** + * Conversation delay in endTimeStamp + */ + @ProtobufProperty(index = 20, type = ProtobufType.UINT32) + private final int conversionDelaySeconds; + + /** + * Forwarding score + */ + @ProtobufProperty(index = 21, type = ProtobufType.UINT32) + private final int forwardingScore; + + /** + * Whether this ContextualMessage is forwarded + */ + @ProtobufProperty(index = 22, type = ProtobufType.BOOL) + private final boolean forwarded; + + /** + * The ad that this ContextualMessage quotes + */ + @ProtobufProperty(index = 23, type = ProtobufType.OBJECT) + private final AdReplyInfo quotedAd; + + /** + * Placeholder key + */ + @ProtobufProperty(index = 24, type = ProtobufType.OBJECT) + private final ChatMessageKey placeholderKey; + + /** + * The expiration in seconds for this ContextualMessage. Only valid if the chat where this message + * was sent is ephemeral. + */ + @ProtobufProperty(index = 25, type = ProtobufType.UINT32) + private int ephemeralExpiration; + + /** + * The timestampSeconds, that is the seconds in seconds since {@link java.time.Instant#EPOCH}, of the + * last modification to the ephemeral settings for the chat where this ContextualMessage was + * sent. + */ + @ProtobufProperty(index = 26, type = ProtobufType.INT64) + private long ephemeralSettingTimestamp; + + /** + * Ephemeral shared secret + */ + @ProtobufProperty(index = 27, type = ProtobufType.BYTES) + private final byte[] ephemeralSharedSecret; + + /** + * External ad reply + */ + @ProtobufProperty(index = 28, type = ProtobufType.OBJECT) + private final ExternalAdReplyInfo externalAdReply; + + /** + * Entry point conversion source + */ + @ProtobufProperty(index = 29, type = ProtobufType.STRING) + private final String entryPointConversionSource; + + /** + * Entry point conversion app + */ + @ProtobufProperty(index = 30, type = ProtobufType.STRING) + private final String entryPointConversionApp; + + /** + * Entry point conversion delay in endTimeStamp + */ + @ProtobufProperty(index = 31, type = ProtobufType.UINT32) + private final int entryPointConversionDelaySeconds; + + /** + * Disappearing mode + */ + @ProtobufProperty(index = 32, type = ProtobufType.OBJECT) + private final ChatDisappear disappearingMode; + + /** + * Action link + */ + @ProtobufProperty(index = 33, type = ProtobufType.OBJECT) + private final ButtonActionLink actionLink; + + /** + * Group subject + */ + @ProtobufProperty(index = 34, type = ProtobufType.STRING) + private final String groupSubject; + + /** + * Parent group + */ + @ProtobufProperty(index = 35, type = ProtobufType.STRING) + private final Jid parentGroup; + + /** + * Trust banner type + */ + @ProtobufProperty(index = 37, type = ProtobufType.STRING) + private final String trustBannerType; + + /** + * Trust banner action + */ + @ProtobufProperty(index = 38, type = ProtobufType.UINT32) + private final int trustBannerAction; + + /** + * The contact that sent the message that this ContextualMessage quotes + */ + private Contact quotedMessageSender; + + /** + * The contact that sent the message that this ContextualMessage quotes + */ + @JsonBackReference + private Chat quotedMessageChat; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public ContextInfo(String quotedMessageId, Jid quotedMessageSenderJid, MessageContainer quotedMessage, Jid quotedMessageChatJid, List mentions, String conversionSource, byte[] conversionData, int conversionDelaySeconds, int forwardingScore, boolean forwarded, AdReplyInfo quotedAd, ChatMessageKey placeholderKey, int ephemeralExpiration, long ephemeralSettingTimestamp, byte[] ephemeralSharedSecret, ExternalAdReplyInfo externalAdReply, String entryPointConversionSource, String entryPointConversionApp, int entryPointConversionDelaySeconds, ChatDisappear disappearingMode, ButtonActionLink actionLink, String groupSubject, Jid parentGroup, String trustBannerType, int trustBannerAction) { + this.quotedMessageId = quotedMessageId; + this.quotedMessageSenderJid = quotedMessageSenderJid; + this.quotedMessage = quotedMessage; + this.quotedMessageChatJid = quotedMessageChatJid; + this.mentions = mentions; + this.conversionSource = conversionSource; + this.conversionData = conversionData; + this.conversionDelaySeconds = conversionDelaySeconds; + this.forwardingScore = forwardingScore; + this.forwarded = forwarded; + this.quotedAd = quotedAd; + this.placeholderKey = placeholderKey; + this.ephemeralExpiration = ephemeralExpiration; + this.ephemeralSettingTimestamp = ephemeralSettingTimestamp; + this.ephemeralSharedSecret = ephemeralSharedSecret; + this.externalAdReply = externalAdReply; + this.entryPointConversionSource = entryPointConversionSource; + this.entryPointConversionApp = entryPointConversionApp; + this.entryPointConversionDelaySeconds = entryPointConversionDelaySeconds; + this.disappearingMode = disappearingMode; + this.actionLink = actionLink; + this.groupSubject = groupSubject; + this.parentGroup = parentGroup; + this.trustBannerType = trustBannerType; + this.trustBannerAction = trustBannerAction; + } + + public static ContextInfo of(MessageInfo quotedMessage) { + return new ContextInfoBuilder() + .quotedMessageId(quotedMessage.id()) + .quotedMessage(quotedMessage.message()) + .quotedMessageChatJid(quotedMessage.parentJid()) + .quotedMessageSenderJid(quotedMessage.senderJid()) + .mentions(new ArrayList<>()) + .build(); + } + + public static ContextInfo empty() { + return new ContextInfoBuilder() + .mentions(new ArrayList<>()) + .build(); + } + + /** + * Returns the sender of the quoted message + * + * @return an optional + */ + public Optional quotedMessageSender() { + return Optional.ofNullable(quotedMessageSender); + } + + public ContextInfo setQuotedMessageSender(Contact quotedMessageSender) { + this.quotedMessageSender = quotedMessageSender; + return this; + } + + /** + * Returns the chat jid of the quoted message + * + * @return an optional + */ + public Optional quotedMessageChatJid() { + return Optional.ofNullable(quotedMessageChatJid).or(this::quotedMessageSenderJid); + } + + /** + * Returns the jid of the sender of the quoted message + * + * @return an optional + */ + public Optional quotedMessageSenderJid() { + return Optional.ofNullable(quotedMessageSenderJid); + } + + /** + * Returns whether this context info has information about a quoted message + * + * @return a boolean + */ + public boolean hasQuotedMessage() { + return quotedMessageId().isPresent() + && quotedMessage().isPresent() + && quotedMessageChat().isPresent(); + } + + /** + * Returns the id of the quoted message + * + * @return an optional + */ + public Optional quotedMessageId() { + return Optional.ofNullable(quotedMessageId); + } + + /** + * Returns the quoted message + * + * @return an optional + */ + public Optional quotedMessage() { + return Optional.ofNullable(quotedMessage); + } + + /** + * Returns the chat of the quoted message + * + * @return an optional + */ + public Optional quotedMessageChat() { + return Optional.ofNullable(quotedMessageChat); + } + + + public ContextInfo setQuotedMessageChat(Chat quotedMessageChat) { + this.quotedMessageChat = quotedMessageChat; + return this; + } + + public List mentions() { + return mentions; + } + + public Optional conversionSource() { + return Optional.ofNullable(conversionSource); + } + + public Optional conversionData() { + return Optional.ofNullable(conversionData); + } + + public int conversionDelaySeconds() { + return conversionDelaySeconds; + } + + public int forwardingScore() { + return forwardingScore; + } + + public boolean forwarded() { + return forwarded; + } + + public Optional quotedAd() { + return Optional.ofNullable(quotedAd); + } + + public Optional placeholderKey() { + return Optional.ofNullable(placeholderKey); + } + + public int ephemeralExpiration() { + return ephemeralExpiration; + } + + public ContextInfo setEphemeralExpiration(int ephemeralExpiration) { + this.ephemeralExpiration = ephemeralExpiration; + return this; + } + + public long ephemeralSettingTimestamp() { + return ephemeralSettingTimestamp; + } + + public ContextInfo setEphemeralSettingTimestamp(long ephemeralSettingTimestamp) { + this.ephemeralSettingTimestamp = ephemeralSettingTimestamp; + return this; + } + + public Optional ephemeralSharedSecret() { + return Optional.ofNullable(ephemeralSharedSecret); + } + + public Optional externalAdReply() { + return Optional.ofNullable(externalAdReply); + } + + public Optional entryPointConversionSource() { + return Optional.ofNullable(entryPointConversionSource); + } + + public Optional entryPointConversionApp() { + return Optional.ofNullable(entryPointConversionApp); + } + + public int entryPointConversionDelaySeconds() { + return entryPointConversionDelaySeconds; + } + + public Optional disappearingMode() { + return Optional.ofNullable(disappearingMode); + } + + public Optional actionLink() { + return Optional.ofNullable(actionLink); + } + + public Optional groupSubject() { + return Optional.ofNullable(groupSubject); + } + + public Optional parentGroup() { + return Optional.ofNullable(parentGroup); + } + + public Optional trustBannerType() { + return Optional.ofNullable(trustBannerType); + } + + public int trustBannerAction() { + return trustBannerAction; + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/DeviceContextInfo.java b/src/main/java/it/auties/whatsapp/model/info/DeviceContextInfo.java new file mode 100644 index 000000000..da626a369 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/DeviceContextInfo.java @@ -0,0 +1,53 @@ +package it.auties.whatsapp.model.info; + +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.sync.DeviceListMetadata; + +import java.util.Optional; + +@ProtobufMessageName("MessageContextInfo") +public final class DeviceContextInfo implements Info, ProtobufMessage { + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + private final DeviceListMetadata deviceListMetadata; + + @ProtobufProperty(index = 2, type = ProtobufType.INT32) + private final int deviceListMetadataVersion; + + @ProtobufProperty(index = 3, type = ProtobufType.BYTES) + private byte[] messageSecret; + + @ProtobufProperty(index = 4, type = ProtobufType.BYTES) + private final byte[] paddingBytes; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public DeviceContextInfo(DeviceListMetadata deviceListMetadata, int deviceListMetadataVersion, byte[] messageSecret, byte[] paddingBytes) { + this.deviceListMetadata = deviceListMetadata; + this.deviceListMetadataVersion = deviceListMetadataVersion; + this.messageSecret = messageSecret; + this.paddingBytes = paddingBytes; + } + + public Optional deviceListMetadata() { + return Optional.ofNullable(deviceListMetadata); + } + + public int deviceListMetadataVersion() { + return deviceListMetadataVersion; + } + + public Optional messageSecret() { + return Optional.ofNullable(messageSecret); + } + + public void setMessageSecret(byte[] messageSecret) { + this.messageSecret = messageSecret; + } + + public Optional paddingBytes() { + return Optional.ofNullable(paddingBytes); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/ExternalAdReplyInfo.java b/src/main/java/it/auties/whatsapp/model/info/ExternalAdReplyInfo.java new file mode 100644 index 000000000..3fa195758 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/ExternalAdReplyInfo.java @@ -0,0 +1,73 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + +import java.util.Optional; + + +/** + * A model class that holds the information related to an advertisement. + */ +@ProtobufMessageName("ContextInfo.ExternalAdReplyInfo") +public record ExternalAdReplyInfo( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + Optional title, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + Optional body, + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + Optional mediaType, + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + Optional thumbnailUrl, + @ProtobufProperty(index = 5, type = ProtobufType.STRING) + Optional mediaUrl, + @ProtobufProperty(index = 6, type = ProtobufType.BYTES) + Optional thumbnail, + @ProtobufProperty(index = 7, type = ProtobufType.STRING) + Optional sourceType, + @ProtobufProperty(index = 8, type = ProtobufType.STRING) + Optional sourceId, + @ProtobufProperty(index = 9, type = ProtobufType.STRING) + Optional sourceUrl, + @ProtobufProperty(index = 10, type = ProtobufType.BOOL) + boolean containsAutoReply, + @ProtobufProperty(index = 11, type = ProtobufType.BOOL) + boolean renderLargerThumbnail, + @ProtobufProperty(index = 12, type = ProtobufType.BOOL) + boolean showAdAttribution, + @ProtobufProperty(index = 13, type = ProtobufType.STRING) + Optional ctwaClid +) implements Info, ProtobufMessage { + /** + * The constants of this enumerated type describe the various types of media that an ad can wrap + */ + @ProtobufMessageName("ChatRowOpaqueData.DraftMessage.CtwaContextData.ContextInfoExternalAdReplyInfoMediaType") + public enum MediaType implements ProtobufEnum { + /** + * No media + */ + NONE(0), + /** + * Image + */ + IMAGE(1), + /** + * Video + */ + VIDEO(2); + + final int index; + + MediaType(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/Info.java b/src/main/java/it/auties/whatsapp/model/info/Info.java new file mode 100644 index 000000000..dfce64e87 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/Info.java @@ -0,0 +1,5 @@ +package it.auties.whatsapp.model.info; + +public sealed interface Info permits AdReplyInfo, BusinessIdentityInfo, ContextInfo, DeviceContextInfo, ExternalAdReplyInfo, MessageIndexInfo, MessageInfo, MessageStatusInfo, NativeFlowInfo, NotificationMessageInfo, PaymentInfo, ProductListInfo, WebNotificationsInfo { + +} diff --git a/src/main/java/it/auties/whatsapp/model/info/MessageIndexInfo.java b/src/main/java/it/auties/whatsapp/model/info/MessageIndexInfo.java new file mode 100644 index 000000000..ed4214cb7 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/MessageIndexInfo.java @@ -0,0 +1,53 @@ +package it.auties.whatsapp.model.info; + +import com.fasterxml.jackson.core.type.TypeReference; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.util.Json; + +import java.util.List; +import java.util.NoSuchElementException; +import java.util.Optional; + +/** + * An index that contains data about a setting change or an action + * + * @param type the type of the change + * @param chatJid the chat where the change happened + * @param messageId the nullable id of the message regarding the chane + * @param fromMe whether the change regards yourself + */ +public record MessageIndexInfo(String type, Optional chatJid, Optional messageId, + boolean fromMe) implements Info { + /** + * Constructs a new message index info + * + * @param type the type of the change + * @param chatJid the chat where the change happened + * @param messageId the nullable id of the message regarding the chane + * @param fromMe whether the change regards yourself + * @return a non-null message index info + */ + public static MessageIndexInfo of(String type, Jid chatJid, String messageId, boolean fromMe) { + return new MessageIndexInfo(type, Optional.ofNullable(chatJid), Optional.ofNullable(messageId), fromMe); + } + + /** + * Constructs a new index info from a json string + * + * @param json the non-null json string + * @return a non-null index info + */ + public static MessageIndexInfo ofJson(String json) { + var array = Json.readValue(json, new TypeReference>() { + }); + var type = getProperty(array, 0).orElseThrow(() -> new NoSuchElementException("Cannot parse MessageSync: missing type")); + var chatJid = getProperty(array, 1).map(Jid::of); + var messageId = getProperty(array, 2); + var fromMe = getProperty(array, 3).map(Boolean::parseBoolean).orElse(false); + return new MessageIndexInfo(type, chatJid, messageId, fromMe); + } + + private static Optional getProperty(List list, int index) { + return list.size() > index ? Optional.ofNullable(list.get(index)) : Optional.empty(); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/info/MessageInfo.java b/src/main/java/it/auties/whatsapp/model/info/MessageInfo.java new file mode 100644 index 000000000..0cee310c8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/MessageInfo.java @@ -0,0 +1,23 @@ +package it.auties.whatsapp.model.info; + +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.message.model.MessageContainer; +import it.auties.whatsapp.util.Json; + +import java.util.OptionalLong; + +public sealed interface MessageInfo extends Info permits ChatMessageInfo, NewsletterMessageInfo, MessageStatusInfo, QuotedMessageInfo { + Jid parentJid(); + + Jid senderJid(); + + String id(); + + MessageContainer message(); + + OptionalLong timestampSeconds(); + + default String toJson() { + return Json.writeValueAsString(this, true); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/MessageStatusInfo.java b/src/main/java/it/auties/whatsapp/model/info/MessageStatusInfo.java new file mode 100644 index 000000000..2d975cfc3 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/MessageStatusInfo.java @@ -0,0 +1,9 @@ +package it.auties.whatsapp.model.info; + +import it.auties.whatsapp.model.message.model.MessageStatus; + +public sealed interface MessageStatusInfo extends Info, MessageInfo permits ChatMessageInfo, NewsletterMessageInfo { + MessageStatus status(); + + T setStatus(MessageStatus status); +} diff --git a/src/main/java/it/auties/whatsapp/model/info/NativeFlowInfo.java b/src/main/java/it/auties/whatsapp/model/info/NativeFlowInfo.java new file mode 100644 index 000000000..2671512dd --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/NativeFlowInfo.java @@ -0,0 +1,23 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.base.ButtonBody; + +/** + * A model class that holds the information related to a native flow. + */ +@ProtobufMessageName("Message.ButtonsMessage.Button.NativeFlowInfo") +public record NativeFlowInfo( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String name, + @ProtobufProperty(index = 2, type = ProtobufType.STRING) + String parameters +) implements Info, ButtonBody, ProtobufMessage { + @Override + public Type bodyType() { + return Type.NATIVE_FLOW; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/info/NewsletterMessageInfo.java b/src/main/java/it/auties/whatsapp/model/info/NewsletterMessageInfo.java new file mode 100644 index 000000000..ef1a9a0d2 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/NewsletterMessageInfo.java @@ -0,0 +1,168 @@ +package it.auties.whatsapp.model.info; + +import com.fasterxml.jackson.annotation.JsonBackReference; +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.message.model.MessageContainer; +import it.auties.whatsapp.model.message.model.MessageStatus; +import it.auties.whatsapp.model.newsletter.Newsletter; +import it.auties.whatsapp.model.newsletter.NewsletterReaction; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.*; + +public final class NewsletterMessageInfo implements MessageInfo, MessageStatusInfo, ProtobufMessage { + @JsonBackReference + private Newsletter newsletter; + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + private final String id; + @ProtobufProperty(index = 2, type = ProtobufType.INT32) + private final int serverId; + @ProtobufProperty(index = 3, type = ProtobufType.UINT64) + private final Long timestampSeconds; + @ProtobufProperty(index = 4, type = ProtobufType.UINT64) + private final Long views; + @ProtobufProperty(index = 5, type = ProtobufType.MAP, keyType = ProtobufType.STRING, valueType = ProtobufType.OBJECT) + final Map reactions; + @ProtobufProperty(index = 6, type = ProtobufType.OBJECT) + private final MessageContainer message; + @ProtobufProperty(index = 7, type = ProtobufType.OBJECT) + private MessageStatus status; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public NewsletterMessageInfo(String id, int serverId, Long timestampSeconds, Long views, Map reactions, MessageContainer message, MessageStatus status) { + this.id = id; + this.serverId = serverId; + this.timestampSeconds = timestampSeconds; + this.views = views; + this.reactions = reactions; + this.message = message; + this.status = status; + } + + public NewsletterMessageInfo setNewsletter(Newsletter newsletter) { + this.newsletter = newsletter; + return this; + } + + public Jid newsletterJid() { + return newsletter.jid(); + } + + @Override + public Jid parentJid() { + return newsletterJid(); + } + + @Override + public Jid senderJid() { + return newsletterJid(); + } + + public Newsletter newsletter() { + return newsletter; + } + + public String id() { + return id; + } + + public int serverId() { + return serverId; + } + + @Override + public OptionalLong timestampSeconds() { + return timestampSeconds == null ? OptionalLong.empty() : OptionalLong.of(timestampSeconds); + } + + public OptionalLong views() { + return views == null ? OptionalLong.empty() : OptionalLong.of(views); + } + + public MessageContainer message() { + return message; + } + + public Optional timestamp() { + return Clock.parseSeconds(timestampSeconds); + } + + @Override + public MessageStatus status() { + return status; + } + + @Override + public NewsletterMessageInfo setStatus(MessageStatus status) { + this.status = status; + return this; + } + + public Collection reactions() { + return Collections.unmodifiableCollection(reactions.values()); + } + + public Optional findReaction(String value) { + return Optional.ofNullable(reactions.get(value)); + } + + public Optional addReaction(NewsletterReaction reaction) { + return Optional.ofNullable(reactions.put(reaction.content(), reaction)); + } + + public Optional removeReaction(String code) { + return Optional.ofNullable(reactions.remove(code)); + } + + public void incrementReaction(String code, boolean fromMe) { + findReaction(code).ifPresentOrElse(reaction -> { + reaction.setCount(reaction.count() + 1); + reaction.setFromMe(fromMe); + }, () -> { + var reaction = new NewsletterReaction(code, 1, fromMe); + addReaction(reaction); + }); + } + + public void decrementReaction(String code) { + findReaction(code).ifPresent(reaction -> { + if(reaction.count() <= 1) { + removeReaction(reaction.content()); + return; + } + + reaction.setCount(reaction.count() - 1); + reaction.setFromMe(false); + }); + } + + @Override + public String toString() { + return "NewsletterMessageInfo{" + + "newsletter=" + newsletter + + ", id='" + id + '\'' + + ", serverId=" + serverId + + ", timestampSeconds=" + timestampSeconds + + ", views=" + views + + ", reactions=" + reactions + + ", message=" + message + + ", status=" + status + + '}'; + } + + @Override + public boolean equals(Object obj) { + return obj instanceof NewsletterMessageInfo that && Objects.equals(this.id(), that.id()); + } + + @Override + public int hashCode() { + return Objects.hash(id); + } + +} diff --git a/src/main/java/it/auties/whatsapp/model/info/NotificationMessageInfo.java b/src/main/java/it/auties/whatsapp/model/info/NotificationMessageInfo.java new file mode 100644 index 000000000..fd6fbaccd --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/NotificationMessageInfo.java @@ -0,0 +1,33 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.message.model.ChatMessageKey; +import it.auties.whatsapp.model.message.model.MessageContainer; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + +@ProtobufMessageName("NotificationMessageInfo") +public record NotificationMessageInfo( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + ChatMessageKey key, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + MessageContainer message, + @ProtobufProperty(index = 3, type = ProtobufType.UINT64) + long messageTimestampSeconds, + @ProtobufProperty(index = 4, type = ProtobufType.STRING) + Optional participant +) implements Info, ProtobufMessage { + /** + * Returns when the message was sent + * + * @return an optional + */ + public Optional messageTimestamp() { + return Clock.parseSeconds(messageTimestampSeconds); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/info/PaymentInfo.java b/src/main/java/it/auties/whatsapp/model/info/PaymentInfo.java new file mode 100644 index 000000000..c1dd58495 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/PaymentInfo.java @@ -0,0 +1,206 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufEnum; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.message.model.ChatMessageKey; +import it.auties.whatsapp.model.payment.PaymentMoney; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.Optional; + + +/** + * A model class that holds the information related to a payment. + */ +@ProtobufMessageName("PaymentInfo") +public record PaymentInfo( + @Deprecated + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + Currency currencyDeprecated, + @ProtobufProperty(index = 2, type = ProtobufType.UINT64) + long amount1000, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + Jid receiverJid, + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + Status status, + @ProtobufProperty(index = 5, type = ProtobufType.UINT64) + long transactionTimestampSeconds, + @ProtobufProperty(index = 6, type = ProtobufType.OBJECT) + ChatMessageKey requestMessageKey, + @ProtobufProperty(index = 7, type = ProtobufType.UINT64) + long expiryTimestampSeconds, + @ProtobufProperty(index = 8, type = ProtobufType.BOOL) + boolean futureProofed, + @ProtobufProperty(index = 9, type = ProtobufType.STRING) + String currency, + @ProtobufProperty(index = 10, type = ProtobufType.OBJECT) + TransactionStatus transactionStatus, + @ProtobufProperty(index = 11, type = ProtobufType.BOOL) + boolean useNoviFormat, + @ProtobufProperty(index = 12, type = ProtobufType.OBJECT) + PaymentMoney primaryAmount, + @ProtobufProperty(index = 13, type = ProtobufType.OBJECT) + PaymentMoney exchangeAmount +) implements Info, ProtobufMessage { + /** + * Returns when the transaction happened + * + * @return an optional + */ + public Optional transactionTimestamp() { + return Clock.parseSeconds(transactionTimestampSeconds); + } + + /** + * Returns when the transaction expires + * + * @return an optional + */ + public Optional expiryTimestamp() { + return Clock.parseSeconds(expiryTimestampSeconds); + } + + /** + * The constants of this enumerated type describe the status of a payment described by a + * {@link PaymentInfo} + */ + @ProtobufMessageName("PaymentInfo.Status") + public enum Status implements ProtobufEnum { + /** + * Unknown status + */ + UNKNOWN_STATUS(0), + /** + * Processing + */ + PROCESSING(1), + /** + * Sent + */ + SENT(2), + /** + * Need to accept + */ + NEED_TO_ACCEPT(3), + /** + * Complete + */ + COMPLETE(4), + /** + * Could not complete + */ + COULD_NOT_COMPLETE(5), + /** + * Refunded + */ + REFUNDED(6), + /** + * Expired + */ + EXPIRED(7), + /** + * Rejected + */ + REJECTED(8), + /** + * Cancelled + */ + CANCELLED(9), + /** + * Waiting for payer + */ + WAITING_FOR_PAYER(10), + /** + * Waiting + */ + WAITING(11); + + final int index; + + Status(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } + + /** + * The constants of this enumerated type describe the currencies supported for a transaction + * described by a {@link PaymentInfo} + */ + @ProtobufMessageName("PaymentInfo.Currency") + public enum Currency implements ProtobufEnum { + /** + * Unknown currency + */ + UNKNOWN_CURRENCY(0), + /** + * Indian rupees + */ + INR(1); + + final int index; + + Currency(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } + + @ProtobufMessageName("PaymentInfo.TxnStatus") + public enum TransactionStatus implements ProtobufEnum { + UNKNOWN(0), + PENDING_SETUP(1), + PENDING_RECEIVER_SETUP(2), + INIT(3), + SUCCESS(4), + COMPLETED(5), + FAILED(6), + FAILED_RISK(7), + FAILED_PROCESSING(8), + FAILED_RECEIVER_PROCESSING(9), + FAILED_DA(10), + FAILED_DA_FINAL(11), + REFUNDED_TXN(12), + REFUND_FAILED(13), + REFUND_FAILED_PROCESSING(14), + REFUND_FAILED_DA(15), + EXPIRED_TXN(16), + AUTH_CANCELED(17), + AUTH_CANCEL_FAILED_PROCESSING(18), + AUTH_CANCEL_FAILED(19), + COLLECT_INIT(20), + COLLECT_SUCCESS(21), + COLLECT_FAILED(22), + COLLECT_FAILED_RISK(23), + COLLECT_REJECTED(24), + COLLECT_EXPIRED(25), + COLLECT_CANCELED(26), + COLLECT_CANCELLING(27), + IN_REVIEW(28), + REVERSAL_SUCCESS(29), + REVERSAL_PENDING(30), + REFUND_PENDING(31); + + final int index; + + TransactionStatus(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/info/ProductListInfo.java b/src/main/java/it/auties/whatsapp/model/info/ProductListInfo.java new file mode 100644 index 000000000..a2aff998d --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/ProductListInfo.java @@ -0,0 +1,26 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.product.ProductListHeaderImage; +import it.auties.whatsapp.model.product.ProductSection; + +import java.util.List; + +/** + * A model class that holds the information related to a list of products. + */ +@ProtobufMessageName("Message.ListMessage.ProductListInfo") +public record ProductListInfo( + @ProtobufProperty(index = 1, type = ProtobufType.OBJECT) + List productSections, + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + ProductListHeaderImage headerImage, + @ProtobufProperty(index = 3, type = ProtobufType.STRING) + Jid seller +) implements Info, ProtobufMessage { + +} diff --git a/src/main/java/it/auties/whatsapp/model/info/QuotedMessageInfo.java b/src/main/java/it/auties/whatsapp/model/info/QuotedMessageInfo.java new file mode 100644 index 000000000..75698cd0f --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/QuotedMessageInfo.java @@ -0,0 +1,102 @@ +package it.auties.whatsapp.model.info; + +import com.fasterxml.jackson.annotation.JsonCreator; +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.contact.Contact; +import it.auties.whatsapp.model.jid.Jid; +import it.auties.whatsapp.model.message.model.MessageContainer; + +import java.util.Objects; +import java.util.Optional; +import java.util.OptionalLong; + +/** + * An immutable model class that represents a quoted message + */ +public final class QuotedMessageInfo implements MessageInfo { + /** + * The id of the message + */ + private final String id; + + /** + * The chat of the message + */ + private final Chat chat; + + /** + * The sender of the message + */ + private final Contact sender; + + /** + * The message + */ + private final MessageContainer message; + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + public QuotedMessageInfo(String id, Chat chat, Contact sender, MessageContainer message) { + this.id = id; + this.chat = chat; + this.sender = sender; + this.message = message; + } + + /** + * Constructs a quoted message from a context info + * + * @param contextInfo the non-null context info + * @return an optional quoted message + */ + public static Optional of(ContextInfo contextInfo) { + if (!contextInfo.hasQuotedMessage()) { + return Optional.empty(); + } + var id = contextInfo.quotedMessageId().orElseThrow(); + var chat = contextInfo.quotedMessageChat().orElseThrow(); + var sender = contextInfo.quotedMessageSender().orElse(null); + var message = contextInfo.quotedMessage().orElseThrow(); + return Optional.of(new QuotedMessageInfo(id, chat, sender, message)); + } + + @Override + public Jid parentJid() { + return chat.jid(); + } + + /** + * Returns the sender's jid + * + * @return a jid + */ + @Override + public Jid senderJid() { + return Objects.requireNonNullElseGet(sender.jid(), this::parentJid); + } + + /** + * Returns the sender of this message + * + * @return an optional + */ + public Optional sender() { + return Optional.ofNullable(sender); + } + + public String id() { + return id; + } + + public Optional chat() { + return Optional.of(chat); + } + + public MessageContainer message() { + return message; + } + + @Override + public OptionalLong timestampSeconds() { + return OptionalLong.empty(); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/info/WebNotificationsInfo.java b/src/main/java/it/auties/whatsapp/model/info/WebNotificationsInfo.java new file mode 100644 index 000000000..8201b6ef4 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/info/WebNotificationsInfo.java @@ -0,0 +1,32 @@ +package it.auties.whatsapp.model.info; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.util.Clock; + +import java.time.ZonedDateTime; +import java.util.List; +import java.util.Optional; + +@ProtobufMessageName("WebNotificationsInfo") +public record WebNotificationsInfo( + @ProtobufProperty(index = 2, type = ProtobufType.UINT64) + long timestampSeconds, + @ProtobufProperty(index = 3, type = ProtobufType.UINT32) + int unreadChats, + @ProtobufProperty(index = 4, type = ProtobufType.UINT32) + int notifyMessageCount, + @ProtobufProperty(index = 5, type = ProtobufType.OBJECT) + List notifyMessages +) implements Info, ProtobufMessage { + /** + * Returns when the notification was sent + * + * @return an optional + */ + public Optional timestamp() { + return Clock.parseSeconds(timestampSeconds); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/jid/Jid.java b/src/main/java/it/auties/whatsapp/model/jid/Jid.java new file mode 100644 index 000000000..390668a70 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/jid/Jid.java @@ -0,0 +1,277 @@ +package it.auties.whatsapp.model.jid; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; +import it.auties.protobuf.annotation.ProtobufConverter; +import it.auties.whatsapp.model.signal.session.SessionAddress; + +import java.util.Objects; + +/** + * A model class that represents a jid. This class is only a model, this means that changing its + * values will have no real effect on WhatsappWeb's servers. + */ +public record Jid(String user, JidServer server, Integer device, Integer agent) implements JidProvider { + /** + * Default constructor + */ + public Jid(String user, JidServer server, Integer device, Integer agent) { + this.user = user != null && user.startsWith("+") ? user.substring(1) : user; + this.server = server; + this.device = device; + this.agent = agent; + } + + /** + * Constructs a new ContactId that represents a server + * + * @param server the non-null custom server + * @return a non-null contact jid + */ + public static Jid ofServer(JidServer server) { + return of(null, server); + } + + @ProtobufConverter // Reserved for protobuf + public static Jid ofProtobuf(String input) { + return input == null ? null : Jid.of(input); + } + + /** + * Constructs a new ContactId for a user from a jid and a custom server + * + * @param jid the nullable jid of the user + * @param server the non-null custom server + * @return a non-null contact jid + */ + public static Jid of(String jid, JidServer server) { + var complexUser = withoutServer(jid); + if (complexUser == null) { + return new Jid(null, server, null, null); + } + + if (complexUser.contains(":")) { + var simpleUser = complexUser.split(":", 2); + var user = simpleUser[0]; + var device = Integer.parseUnsignedInt(simpleUser[1]); + if (user.contains("_")) { + var simpleUserAgent = user.split("_", 2); + var agent = tryParseAgent(simpleUserAgent[1]); + return new Jid(simpleUserAgent[0], server, device, agent); + } + return new Jid(user, server, device, null); + } + + if (!complexUser.contains("_")) { + return new Jid(complexUser, server, null, null); + } + + var simpleUserAgent = complexUser.split("_", 2); + var agent = tryParseAgent(simpleUserAgent[1]); + return new Jid(simpleUserAgent[0], server, null, agent); + } + + /** + * Parses a nullable jid to the Whatsapp Jid Format + * + * @param jid the nullable jid to parse + * @return null if {@code jid == null}, otherwise a non-null string + */ + public static String withoutServer(String jid) { + if (jid == null) { + return null; + } + for (var server : JidServer.values()) { + jid = jid.replace("@%s".formatted(server), ""); + } + return jid; + } + + private static Integer tryParseAgent(String string) { + try { + return Integer.parseUnsignedInt(string); + } catch (NumberFormatException exception) { + return null; + } + } + + /** + * Constructs a new ContactId for a device + * + * @param jid the nullable jid of the user + * @param device the device jid + * @return a non-null contact jid + */ + public static Jid ofDevice(String jid, int device) { + return new Jid(withoutServer(jid), JidServer.WHATSAPP, device, null); + } + + /** + * Constructs a new ContactId for a user from a jid + * + * @param jid the non-null jid of the user + * @return a non-null contact jid + */ + @JsonCreator + public static Jid of(String jid) { + return of(jid, JidServer.of(jid)); + } + + /** + * Constructs a new ContactId for a user from a jid + * + * @param jid the non-null jid of the user + * @return a non-null contact jid + */ + public static Jid of(long jid) { + return of(String.valueOf(jid), JidServer.WHATSAPP); + } + + /** + * Returns the type of this jid + * + * @return a non null type + */ + public JidType type() { + return isCompanion() ? JidType.COMPANION : switch (server()) { + case WHATSAPP -> Objects.equals(user(), "16505361212") ? JidType.OFFICIAL_SURVEY_ACCOUNT : JidType.USER; + case LID -> JidType.LID; + case BROADCAST -> Objects.equals(user(), "status") ? JidType.STATUS : JidType.BROADCAST; + case GROUP -> JidType.GROUP; + case GROUP_CALL -> JidType.GROUP_CALL; + case NEWSLETTER -> JidType.NEWSLETTER; + case USER -> switch (user()) { + case "server" -> JidType.SERVER; + case "0" -> JidType.ANNOUNCEMENT; + case "16508638904" -> JidType.IAS; + case "16505361212" -> JidType.OFFICIAL_BUSINESS_ACCOUNT; + default -> JidType.UNKNOWN; + }; + }; + } + + /** + * Returns whether this jid is associated with a companion device + * + * @return true if this jid is a companion + */ + public boolean isCompanion() { + return device() != 0; + } + + /** + * Returns whether this jid ends with the provided server + * + * @param server the server to check against + * @return a boolean + */ + public boolean hasServer(JidServer server) { + return server() == server; + } + + /** + * Returns whether this jid is a server jid + * + * @param server the server to check against + * @return a boolean + */ + public boolean isServerJid(JidServer server) { + return user() == null && server() == server; + } + + /** + * Returns a new jid using with a different server + * + * @param server the new server + * @return a non-null jid + */ + public Jid withServer(JidServer server) { + return new Jid(user(), server, device, agent); + } + + /** + * Converts this jid to a user jid + * + * @return a non-null jid + */ + public Jid toSimpleJid() { + return of(user(), server()); + } + + /** + * Converts this jid to a non-formatted phone number + * + * @return a non-null String + */ + public String toPhoneNumber() { + return "+%s".formatted(user); + } + + /** + * Converts this jid to a String + * + * @return a non-null String + */ + @JsonValue + @ProtobufConverter + @Override + public String toString() { + var user = Objects.requireNonNullElse(user(), ""); + var agent = hasAgent() ? "_%s".formatted(agent()) : ""; + var device = hasDevice() ? ":%s".formatted(device()) : ""; + var leading = "%s%s%s".formatted(user, agent, device); + return leading.isEmpty() ? server().toString() : "%s@%s".formatted(leading, server()); + } + + /** + * Converts this jid to a signal address + * + * @return a non-null {@link SessionAddress} + */ + public SessionAddress toSignalAddress() { + return new SessionAddress(user(), device()); + } + + /** + * Returns this object as a jid + * + * @return a non-null jid + */ + @Override + public Jid toJid() { + return this; + } + + @Override + public Integer device() { + return Objects.requireNonNullElse(device, 0); + } + + /** + * Returns whether this jid specifies a device + * + * @return a boolean + */ + public boolean hasDevice() { + return device != null; + } + + @Override + public Integer agent() { + return Objects.requireNonNullElse(agent, 0); + } + + /** + * Returns whether this jid specifies an agent + * + * @return a boolean + */ + public boolean hasAgent() { + return agent != null; + } + + @Override + public int hashCode() { + return Objects.hashCode(toString()); + } +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/jid/JidProvider.java b/src/main/java/it/auties/whatsapp/model/jid/JidProvider.java new file mode 100644 index 000000000..b89471449 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/jid/JidProvider.java @@ -0,0 +1,17 @@ +package it.auties.whatsapp.model.jid; + +import it.auties.whatsapp.model.chat.Chat; +import it.auties.whatsapp.model.contact.Contact; +import it.auties.whatsapp.model.newsletter.Newsletter; + +/** + * Utility interface to make providing a jid easier + */ +public sealed interface JidProvider permits Chat, Newsletter, Contact, Jid { + /** + * Returns this object as a jid + * + * @return a non-null jid + */ + Jid toJid(); +} diff --git a/src/main/java/it/auties/whatsapp/model/jid/JidServer.java b/src/main/java/it/auties/whatsapp/model/jid/JidServer.java new file mode 100644 index 000000000..7a3998f3a --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/jid/JidServer.java @@ -0,0 +1,69 @@ +package it.auties.whatsapp.model.jid; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +import java.util.Arrays; + +/** + * The constants of this enumerated type describe the various servers that a jid might be linked + * to + */ +public enum JidServer { + /** + * User + */ + USER("c.us"), + /** + * Groups and communities + */ + GROUP("g.us"), + /** + * Broadcast group + */ + BROADCAST("broadcast"), + /** + * Group call + */ + GROUP_CALL("call"), + /** + * Whatsapp + */ + WHATSAPP("s.whatsapp.net"), + /** + * Lid + */ + LID("lid"), + /** + * Newsletter + */ + NEWSLETTER("newsletter"); + + private final String address; + + JidServer(String address) { + this.address = address; + } + + @JsonCreator + public static JidServer of(String address) { + return Arrays.stream(values()) + .filter(entry -> address != null && address.endsWith(entry.address())) + .findFirst() + .orElse(WHATSAPP); + } + + public String address() { + return address; + } + + public Jid toJid() { + return Jid.ofServer(this); + } + + @Override + @JsonValue + public String toString() { + return address(); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/jid/JidType.java b/src/main/java/it/auties/whatsapp/model/jid/JidType.java new file mode 100644 index 000000000..020cfbffb --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/jid/JidType.java @@ -0,0 +1,63 @@ +package it.auties.whatsapp.model.jid; + +/** + * The constants of this enumerated type describe the various types of jids currently supported + */ +public enum JidType { + /** + * Represents a device connected using the multi device beta + */ + COMPANION, + /** + * Regular Whatsapp contact Jid + */ + USER, + /** + * Official survey account + */ + OFFICIAL_SURVEY_ACCOUNT, + /** + * Lid + */ + LID, + /** + * Broadcast list + */ + BROADCAST, + /** + * Official business account + */ + OFFICIAL_BUSINESS_ACCOUNT, + /** + * Group Chat Jid + */ + GROUP, + /** + * Group Call Jid + */ + GROUP_CALL, + /** + * Server Jid: Used to send nodes to Whatsapp usually + */ + SERVER, + /** + * Announcements Chat Jid: Read only chat, usually used by Whatsapp for log updates + */ + ANNOUNCEMENT, + /** + * IAS Chat jid + */ + IAS, + /** + * Image Status Jid of a contact + */ + STATUS, + /** + * Unknown Jid type + */ + UNKNOWN, + /** + * Channel + */ + NEWSLETTER +} diff --git a/src/main/java/it/auties/whatsapp/model/media/AttachmentType.java b/src/main/java/it/auties/whatsapp/model/media/AttachmentType.java new file mode 100644 index 000000000..b91596cc6 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/AttachmentType.java @@ -0,0 +1,55 @@ +package it.auties.whatsapp.model.media; + +import java.util.Optional; + +/** + * The constants of this enumerated type describe the various types of attachments supported by Whatsapp + */ +public enum AttachmentType { + NONE(null, null, false), + AUDIO("mms/audio", "WhatsApp Audio Keys", false), + DOCUMENT("mms/document", "WhatsApp Document Keys", false), + GIF("mms/gif", "WhatsApp Video Keys", false), + IMAGE("mms/image", "WhatsApp Image Keys", false), + PROFILE_PICTURE("pps/photo", null, false), + PRODUCT("mms/image", "WhatsApp Image Keys", false), + VOICE("mms/ptt", "WhatsApp Audio Keys", false), + STICKER("mms/sticker", "WhatsApp Image Keys", false), + THUMBNAIL_DOCUMENT("mms/thumbnail-document", "WhatsApp Document Thumbnail Keys", false), + THUMBNAIL_LINK("mms/thumbnail-link", "WhatsApp Link Thumbnail Keys", false), + VIDEO("mms/video", "WhatsApp Video Keys", false), + APP_STATE("mms/md-app-state", "WhatsApp App State Keys", true), + HISTORY_SYNC("mms/md-msg-hist", "WhatsApp History Keys", true), + PRODUCT_CATALOG_IMAGE("product/image", null, false), + BUSINESS_COVER_PHOTO("pps/biz-cover-photo", null, false), + NEWSLETTER_AUDIO("newsletter/newsletter-audio", null, false), + NEWSLETTER_IMAGE("newsletter/newsletter-image", null, false), + NEWSLETTER_DOCUMENT("newsletter/newsletter-document", null, false), + NEWSLETTER_GIF("newsletter/newsletter-gif", null, false), + NEWSLETTER_VOICE("newsletter/newsletter-ptt", null, false), + NEWSLETTER_STICKER("newsletter/newsletter-sticker", null, false), + NEWSLETTER_THUMBNAIL_LINK("newsletter/newsletter-thumbnail-link", null, false), + NEWSLETTER_VIDEO("newsletter/newsletter-video", null, false); + + private final String path; + private final String keyName; + private final boolean inflatable; + + AttachmentType(String path, String keyName, boolean inflatable) { + this.path = path; + this.keyName = keyName; + this.inflatable = inflatable; + } + + public Optional path() { + return Optional.ofNullable(path); + } + + public Optional keyName() { + return Optional.ofNullable(keyName); + } + + public boolean inflatable() { + return this.inflatable; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/media/MediaConnection.java b/src/main/java/it/auties/whatsapp/model/media/MediaConnection.java new file mode 100644 index 000000000..9f9b3e05b --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/MediaConnection.java @@ -0,0 +1,7 @@ +package it.auties.whatsapp.model.media; + + +import java.util.List; + +public record MediaConnection(String auth, int ttl, int maxBuckets, long timestamp, List hosts) { +} diff --git a/src/main/java/it/auties/whatsapp/model/media/MediaData.java b/src/main/java/it/auties/whatsapp/model/media/MediaData.java new file mode 100644 index 000000000..b8aa3e616 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/MediaData.java @@ -0,0 +1,15 @@ +package it.auties.whatsapp.model.media; + +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.protobuf.model.ProtobufType; + + +@ProtobufMessageName("MediaData") +public record MediaData( + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + String localPath +) implements ProtobufMessage { + +} \ No newline at end of file diff --git a/src/main/java/it/auties/whatsapp/model/media/MediaDimensions.java b/src/main/java/it/auties/whatsapp/model/media/MediaDimensions.java new file mode 100644 index 000000000..c712c2f2c --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/MediaDimensions.java @@ -0,0 +1,11 @@ +package it.auties.whatsapp.model.media; + +import com.fasterxml.jackson.annotation.JsonProperty; + +public record MediaDimensions(@JsonProperty("width") int width, @JsonProperty("height") int height) { + private static final MediaDimensions DEFAULT = new MediaDimensions(128, 128); + + public static MediaDimensions defaultDimensions() { + return DEFAULT; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/media/MediaFile.java b/src/main/java/it/auties/whatsapp/model/media/MediaFile.java new file mode 100644 index 000000000..5c3e3a053 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/MediaFile.java @@ -0,0 +1,6 @@ +package it.auties.whatsapp.model.media; + +public record MediaFile(byte[] encryptedFile, byte[] fileSha256, byte[] fileEncSha256, byte[] mediaKey, long fileLength, + String directPath, String url, String handle, Long timestamp) { + +} diff --git a/src/main/java/it/auties/whatsapp/model/media/MediaKeys.java b/src/main/java/it/auties/whatsapp/model/media/MediaKeys.java new file mode 100644 index 000000000..477c1bedb --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/MediaKeys.java @@ -0,0 +1,28 @@ +package it.auties.whatsapp.model.media; + +import it.auties.whatsapp.crypto.Hkdf; +import it.auties.whatsapp.util.Bytes; + +import java.nio.charset.StandardCharsets; +import java.util.Arrays; + +import static it.auties.whatsapp.util.Specification.Signal.IV_LENGTH; +import static it.auties.whatsapp.util.Specification.Signal.KEY_LENGTH; + +public record MediaKeys(byte[] mediaKey, byte[] iv, byte[] cipherKey, byte[] macKey, byte[] ref) { + private static final int EXPANDED_SIZE = 112; + + public static MediaKeys random(String type) { + return of(Bytes.random(32), type); + } + + public static MediaKeys of(byte[] key, String type) { + var keyName = type.getBytes(StandardCharsets.UTF_8); + var expanded = Hkdf.extractAndExpand(key, keyName, EXPANDED_SIZE); + var iv = Arrays.copyOfRange(expanded, 0, IV_LENGTH); + var cipherKey = Arrays.copyOfRange(expanded, IV_LENGTH, IV_LENGTH + KEY_LENGTH); + var macKey = Arrays.copyOfRange(expanded, IV_LENGTH + KEY_LENGTH, IV_LENGTH + KEY_LENGTH * 2); + var ref = Arrays.copyOfRange(expanded, IV_LENGTH + KEY_LENGTH * 2, expanded.length); + return new MediaKeys(key, iv, cipherKey, macKey, ref); + } +} diff --git a/src/main/java/it/auties/whatsapp/model/media/MediaUpload.java b/src/main/java/it/auties/whatsapp/model/media/MediaUpload.java new file mode 100644 index 000000000..fb6730cf3 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/MediaUpload.java @@ -0,0 +1,8 @@ +package it.auties.whatsapp.model.media; + +import com.fasterxml.jackson.annotation.JsonProperty; + +public record MediaUpload(@JsonProperty("direct_path") String directPath, @JsonProperty("url") String url, + @JsonProperty("handle") String handle) { + +} diff --git a/src/main/java/it/auties/whatsapp/model/media/MediaVisibility.java b/src/main/java/it/auties/whatsapp/model/media/MediaVisibility.java new file mode 100644 index 000000000..1f81152c8 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/MediaVisibility.java @@ -0,0 +1,35 @@ +package it.auties.whatsapp.model.media; + +import it.auties.protobuf.annotation.ProtobufEnumIndex; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.model.ProtobufEnum; + +/** + * The constants of this enumerated type describe the various types of media visibility that can be + * set for a chat + */ +@ProtobufMessageName("MediaVisibility") +public enum MediaVisibility implements ProtobufEnum { + /** + * Default + */ + DEFAULT(0), + /** + * Off + */ + OFF(1), + /** + * On + */ + ON(2); + + final int index; + + MediaVisibility(@ProtobufEnumIndex int index) { + this.index = index; + } + + public int index() { + return index; + } +} diff --git a/src/main/java/it/auties/whatsapp/model/media/MutableAttachmentProvider.java b/src/main/java/it/auties/whatsapp/model/media/MutableAttachmentProvider.java new file mode 100644 index 000000000..c123b1903 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/media/MutableAttachmentProvider.java @@ -0,0 +1,114 @@ +package it.auties.whatsapp.model.media; + +import it.auties.protobuf.model.ProtobufMessage; +import it.auties.whatsapp.model.message.model.MediaMessage; +import it.auties.whatsapp.model.sync.ExternalBlobReference; +import it.auties.whatsapp.model.sync.HistorySyncNotification; + +import java.util.Optional; +import java.util.OptionalLong; + +/** + * A sealed interface that represents a class that can provide data about a media + */ +public sealed interface MutableAttachmentProvider> extends ProtobufMessage + permits MediaMessage, ExternalBlobReference, HistorySyncNotification { + /** + * Returns the url to the media + * + * @return a nullable String + */ + Optional mediaUrl(); + + /** + * Sets the media url of this provider + * + * @return the same provider + */ + T setMediaUrl(String mediaUrl); + + /** + * Returns the direct path to the media + * + * @return a nullable String + */ + Optional mediaDirectPath(); + + /** + * Sets the direct path of this provider + * + * @return the same provider + */ + T setMediaDirectPath(String mediaDirectPath); + + /** + * Returns the key of this media + * + * @return a non-null array of bytes + */ + Optional mediaKey(); + + /** + * Sets the media key of this provider + * + * @return the same provider + */ + T setMediaKey(byte[] bytes); + + /** + * Sets the timestamp of the media key + * + * @return the same provider + */ + T setMediaKeyTimestamp(Long timestamp); + + /** + * Returns the sha256 of this media + * + * @return a non-null array of bytes + */ + Optional mediaSha256(); + + /** + * Sets the sha256 of the media in this provider + * + * @return the same provider + */ + T setMediaSha256(byte[] bytes); + + /** + * Returns the sha256 of this encrypted media + * + * @return a non-null array of bytes + */ + Optional mediaEncryptedSha256(); + + /** + * Sets the sha256 of the encrypted media in this provider + * + * @return the same provider + */ + T setMediaEncryptedSha256(byte[] bytes); + + /** + * Returns the size of this media + * + * @return a long + */ + OptionalLong mediaSize(); + + /** + * Sets the size of this media + * + * @return a long + */ + T setMediaSize(long mediaSize); + + + /** + * Returns the type of this attachment + * + * @return a non-null attachment + */ + AttachmentType attachmentType(); +} diff --git a/src/main/java/it/auties/whatsapp/model/message/button/ButtonsMessage.java b/src/main/java/it/auties/whatsapp/model/message/button/ButtonsMessage.java new file mode 100644 index 000000000..15a64a093 --- /dev/null +++ b/src/main/java/it/auties/whatsapp/model/message/button/ButtonsMessage.java @@ -0,0 +1,181 @@ +package it.auties.whatsapp.model.message.button; + +import it.auties.protobuf.annotation.ProtobufBuilder; +import it.auties.protobuf.annotation.ProtobufMessageName; +import it.auties.protobuf.annotation.ProtobufProperty; +import it.auties.protobuf.model.ProtobufType; +import it.auties.whatsapp.model.button.base.Button; +import it.auties.whatsapp.model.info.ContextInfo; +import it.auties.whatsapp.model.message.button.ButtonsMessageHeader.Type; +import it.auties.whatsapp.model.message.model.ButtonMessage; +import it.auties.whatsapp.model.message.model.ContextualMessage; +import it.auties.whatsapp.model.message.model.MessageType; +import it.auties.whatsapp.model.message.standard.DocumentMessage; +import it.auties.whatsapp.model.message.standard.ImageMessage; +import it.auties.whatsapp.model.message.standard.LocationMessage; +import it.auties.whatsapp.model.message.standard.VideoOrGifMessage; + +import java.util.List; +import java.util.Optional; + +/** + * A model class that represents a message that contains buttons inside + */ +@ProtobufMessageName("Message.ButtonsMessage") +public final class ButtonsMessage implements ButtonMessage, ContextualMessage { + @ProtobufProperty(index = 1, type = ProtobufType.STRING) + private final ButtonsMessageHeaderText headerText; + @ProtobufProperty(index = 2, type = ProtobufType.OBJECT) + private final DocumentMessage headerDocument; + @ProtobufProperty(index = 3, type = ProtobufType.OBJECT) + private final ImageMessage headerImage; + @ProtobufProperty(index = 4, type = ProtobufType.OBJECT) + private final VideoOrGifMessage headerVideo; + @ProtobufProperty(index = 5, type = ProtobufType.OBJECT) + private final LocationMessage headerLocation; + @ProtobufProperty(index = 6, type = ProtobufType.STRING) + private final String body; + @ProtobufProperty(index = 7, type = ProtobufType.STRING) + private final String footer; + @ProtobufProperty(index = 8, type = ProtobufType.OBJECT) + private ContextInfo contextInfo; + @ProtobufProperty(index = 9, type = ProtobufType.OBJECT) + private final List