it.auties.whatsapp.model.message.standard.PollCreationMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of whatsappweb4j Show documentation
Standalone fully-featured Whatsapp Web API for Java and Kotlin
There is a newer version: 3.5.1
package it.auties.whatsapp.model.message.standard;

import it.auties.protobuf.base.ProtobufName;
import it.auties.protobuf.base.ProtobufProperty;
import it.auties.whatsapp.api.Whatsapp;
import it.auties.whatsapp.crypto.Sha256;
import it.auties.whatsapp.model.contact.ContactJid;
import it.auties.whatsapp.model.contact.ContactJidProvider;
import it.auties.whatsapp.model.info.ContextInfo;
import it.auties.whatsapp.model.info.MessageInfo;
import it.auties.whatsapp.model.message.model.ContextualMessage;
import it.auties.whatsapp.model.message.model.MessageCategory;
import it.auties.whatsapp.model.message.model.MessageType;
import it.auties.whatsapp.model.poll.PollOption;
import it.auties.whatsapp.util.KeyHelper;
import it.auties.whatsapp.util.Validate;
import lombok.*;
import lombok.Builder.Default;
import lombok.experimental.Accessors;
import lombok.experimental.SuperBuilder;
import lombok.extern.jackson.Jacksonized;

import java.util.*;
import java.util.concurrent.ConcurrentHashMap;

import static it.auties.protobuf.base.ProtobufType.*;

/**
 * A model class that represents a message holding a poll inside
 */
@AllArgsConstructor
@Data
@Jacksonized
@SuperBuilder
@Accessors(fluent = true)
@EqualsAndHashCode(callSuper = true)
@ToString(exclude = "selectableOptionsHashesMap")
@ProtobufName("PollCreationMessage")
public final class PollCreationMessage extends ContextualMessage {
    /**
     * The title of the poll
     */
    @ProtobufProperty(index = 2, name = "name", type = STRING)
    private String title;

    /**
     * A list of options that can be selected in the poll
     */
    @ProtobufProperty(implementation = PollOption.class, index = 3, name = "options", repeated = true, type = MESSAGE)
    private List selectableOptions;

    /**
     * Internal field required by the protobuf to count the number of selectable options
     */
    @ProtobufProperty(index = 4, name = "selectableOptionsCount", type = UINT32)
    private int selectableOptionsCount;

    /**
     * The SHA256 hashes of {@link PollCreationMessage#selectableOptions}
     */
    @Default
    private Map selectableOptionsHashesMap = new ConcurrentHashMap<>();

    /**
     * The map of the options selected by each person that can vote in this poll
     */
    @Default
    private Map> selectedOptionsMap = new ConcurrentHashMap<>();

    /**
     * The encryption key of this poll
     */
    @ProtobufProperty(index = 1, name = "encKey", type = BYTES)
    private byte[] encryptionKey;

    /**
     * The context of this message
     */
    @ProtobufProperty(index = 5, name = "contextInfo", type = MESSAGE)
    private ContextInfo contextInfo;

    /**
     * Constructs a new builder to create a PollCreationMessage The result can be later sent using
     * {@link Whatsapp#sendMessage(MessageInfo)}
     *
     * @param title             the non-null title of the poll
     * @param selectableOptions the null-null non-empty options of the poll
     * @return a non-null new message
     */
    @Builder(builderClassName = "SimplePollCreationMessageBuilder", builderMethodName = "simpleBuilder")
    public static PollCreationMessage of(@NonNull String title, @NonNull List selectableOptions) {
        Validate.isTrue(!title.isBlank(), "Title cannot be empty");
        Validate.isTrue(selectableOptions.size() > 1, "Options must have at least two entries");
        return PollCreationMessage.builder()
                .encryptionKey(KeyHelper.senderKey())
                .title(title)
                .selectableOptions(selectableOptions)
                .build();
    }

    /**
     * Returns an unmodifiable list of the options that a contact voted in this poll
     *
     * @param contact the non-null contact that voted in this poll
     * @return a non-null unmodifiable map
     */
    public List selectedOptions(@NonNull ContactJidProvider contact) {
        return Optional.of(selectedOptionsMap.get(contact.toJid()))
                .map(Collections::unmodifiableList)
                .orElseGet(List::of);
    }

    @Override
    public MessageType type() {
        return MessageType.POLL_CREATION;
    }

    @Override
    public MessageCategory category() {
        return MessageCategory.STANDARD;
    }

    public abstract static class PollCreationMessageBuilder> extends ContextualMessageBuilder {
        public PollCreationMessageBuilder selectableOptions(List selectableOptions) {
            if (this.selectableOptions == null) {
                this.selectableOptions = new ArrayList<>();
            }
            selectableOptionsHashesMap$set = true;
            if (selectableOptionsHashesMap$value == null) {
                selectableOptionsHashesMap$value = new HashMap<>();
            }
            selectableOptions.forEach(entry -> {
                var sha256 = HexFormat.of().formatHex(Sha256.calculate(entry.name()));
                selectableOptionsHashesMap$value.put(sha256, entry);
            });
            this.selectableOptions.addAll(selectableOptions);
            this.selectableOptionsCount = selectableOptions.size();
            return this;
        }
    }
}