alfio.model.Ticket.java Source code

Introduction

Here is the source code for alfio.model.Ticket.java

Source

/**
 * This file is part of alf.io.
 *
 * alf.io is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * alf.io 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with alf.io.  If not, see <http://www.gnu.org/licenses/>.
 */
package alfio.model;

import alfio.util.MonetaryUtil;
import ch.digitalfondue.npjt.ConstructorAnnotationRowMapper.Column;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Getter;
import org.apache.commons.codec.digest.HmacAlgorithms;
import org.apache.commons.codec.digest.HmacUtils;
import org.apache.commons.lang3.StringUtils;

import java.time.ZonedDateTime;
import java.util.Base64;
import java.util.EnumSet;
import java.util.Optional;
import java.util.Set;

@Getter
public class Ticket {

    public enum TicketStatus {
        FREE, PENDING, TO_BE_PAID, ACQUIRED, CANCELLED, CHECKED_IN, EXPIRED, INVALIDATED, RELEASED, PRE_RESERVED
    }

    private static final Set<TicketStatus> SOLD_STATUSES = EnumSet.of(TicketStatus.TO_BE_PAID,
            TicketStatus.ACQUIRED, TicketStatus.CANCELLED, TicketStatus.CHECKED_IN, TicketStatus.RELEASED);

    private final int id;
    private final String uuid;
    private final ZonedDateTime creation;
    private final Integer categoryId;
    private final int eventId;
    private final TicketStatus status;
    private final String ticketsReservationId;
    private final String fullName;
    private final String firstName;
    private final String lastName;
    private final String email;
    private final boolean lockedAssignment;
    private final String userLanguage;

    private final int srcPriceCts;
    private final int finalPriceCts;
    private final int vatCts;
    private final int discountCts;
    private final String extReference;

    public Ticket(@JsonProperty("id") @Column("id") int id, @JsonProperty("uuid") @Column("uuid") String uuid,
            @JsonProperty("creation") @Column("creation") ZonedDateTime creation,
            @JsonProperty("categoryId") @Column("category_id") Integer categoryId,
            @JsonProperty("status") @Column("status") String status,
            @JsonProperty("eventId") @Column("event_id") int eventId,
            @JsonProperty("ticketsReservationId") @Column("tickets_reservation_id") String ticketsReservationId,
            @JsonProperty("fullName") @Column("full_name") String fullName,
            @JsonProperty("firstName") @Column("first_name") String firstName,
            @JsonProperty("lastName") @Column("last_name") String lastName,
            @JsonProperty("email") @Column("email_address") String email,
            @JsonProperty("lockedAssignment") @Column("locked_assignment") boolean lockedAssignment,
            @JsonProperty("userLanguage") @Column("user_language") String userLanguage,
            @JsonProperty("srcPriceCts") @Column("src_price_cts") int srcPriceCts,
            @JsonProperty("finalPriceCts") @Column("final_price_cts") int finalPriceCts,
            @JsonProperty("vatCts") @Column("vat_cts") int vatCts,
            @JsonProperty("discountCts") @Column("discount_cts") int discountCts,
            @JsonProperty("extReference") @Column("ext_reference") String extReference) {
        this.id = id;
        this.uuid = uuid;
        this.creation = creation;
        this.categoryId = categoryId;
        this.eventId = eventId;

        this.userLanguage = userLanguage;
        this.status = TicketStatus.valueOf(status);
        this.ticketsReservationId = ticketsReservationId;
        this.fullName = Optional.ofNullable(fullName).orElse("");
        this.firstName = firstName;
        this.lastName = lastName;
        this.email = Optional.ofNullable(email).orElse("");
        this.lockedAssignment = lockedAssignment;
        this.srcPriceCts = srcPriceCts;
        this.finalPriceCts = finalPriceCts;
        this.vatCts = vatCts;
        this.discountCts = discountCts;
        this.extReference = extReference;
    }

    public boolean getAssigned() {
        return (StringUtils.isNotBlank(fullName)
                || (StringUtils.isNotBlank(firstName) && StringUtils.isNotBlank(lastName)))
                && StringUtils.isNotBlank(email);
    }

    public boolean getLockedAssignment() {
        return lockedAssignment;
    }

    /**
     * The code is composed with:
     * 
     * <pre>uuid + '/' + hmac_sha256_base64((ticketsReservationId + '/' + uuid + '/' + fullName + '/' + email), eventKey)</pre>
     * 
     * @param eventKey
     * @return
     */
    public String ticketCode(String eventKey) {
        return uuid + '/' + hmacTicketInfo(eventKey);
    }

    public String hmacTicketInfo(String eventKey) {
        return hmacSHA256Base64(eventKey,
                StringUtils.join(new String[] { ticketsReservationId, uuid, getFullName(), email }, '/'));
    }

    public boolean hasBeenSold() {
        return SOLD_STATUSES.contains(status);
    }

    public boolean isCheckedIn() {
        return status == TicketStatus.CHECKED_IN;
    }

    private static String hmacSHA256Base64(String key, String code) {
        return Base64.getEncoder().encodeToString(new HmacUtils(HmacAlgorithms.HMAC_SHA_256, key).hmac(code));
    }

    public String getFullName() {
        return (firstName != null && lastName != null) ? (firstName + " " + lastName) : fullName;
    }

    public String getFormattedFinalPrice() {
        return MonetaryUtil.formatCents(finalPriceCts);
    }
}