X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FProfile.java;h=b87ef4fe3737ee822fdda60141d373a4bf34ee72;hp=eeb04a41b31ccce6fcc76b43ee2d2ae2b8662fd0;hb=438378deab1514f0f608d975ef65f5b7aea44ccb;hpb=549b1013740e7a95b5ab8ccb0f97f419a0dedb19 diff --git a/src/main/java/net/pterodactylus/sone/data/Profile.java b/src/main/java/net/pterodactylus/sone/data/Profile.java index eeb04a4..b87ef4f 100644 --- a/src/main/java/net/pterodactylus/sone/data/Profile.java +++ b/src/main/java/net/pterodactylus/sone/data/Profile.java @@ -1,5 +1,5 @@ /* - * FreenetSone - Profile.java - Copyright © 2010 David Roden + * Sone - Profile.java - Copyright © 2010–2020 David Roden * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,28 +17,63 @@ package net.pterodactylus.sone.data; +import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkNotNull; +import static com.google.common.base.Preconditions.checkState; +import static java.nio.charset.StandardCharsets.UTF_8; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.UUID; + +import javax.annotation.Nonnull; +import javax.annotation.Nullable; + +import com.google.common.hash.Hasher; +import com.google.common.hash.Hashing; + /** - * A profile stores personal information about a {@link User}. All information + * A profile stores personal information about a {@link Sone}. All information * is optional and can be {@code null}. - * - * @author David ‘Bombe’ Roden */ -public class Profile { +public class Profile implements Fingerprintable { + + /** The Sone this profile belongs to. */ + private final Sone sone; /** The first name. */ - private String firstName; + private volatile String firstName; /** The middle name(s). */ - private String middleName; + private volatile String middleName; /** The last name. */ - private String lastName; + private volatile String lastName; + + /** The day of the birth date. */ + private volatile Integer birthDay; + + /** The month of the birth date. */ + private volatile Integer birthMonth; + + /** The year of the birth date. */ + private volatile Integer birthYear; + + /** The ID of the avatar image. */ + private volatile String avatar; + + /** Additional fields in the profile. */ + private final List fields = Collections.synchronizedList(new ArrayList()); /** * Creates a new empty profile. + * + * @param sone + * The Sone this profile belongs to */ - public Profile() { - /* do nothing. */ + public Profile(Sone sone) { + this.sone = sone; } /** @@ -47,10 +82,16 @@ public class Profile { * @param profile * The profile to copy */ - public Profile(Profile profile) { + public Profile(@Nonnull Profile profile) { + this.sone = profile.sone; this.firstName = profile.firstName; this.middleName = profile.middleName; this.lastName = profile.lastName; + this.birthDay = profile.birthDay; + this.birthMonth = profile.birthMonth; + this.birthYear = profile.birthYear; + this.avatar = profile.avatar; + this.fields.addAll(profile.fields); } // @@ -58,10 +99,21 @@ public class Profile { // /** + * Returns the Sone this profile belongs to. + * + * @return The Sone this profile belongs to + */ + @Nonnull + public Sone getSone() { + return sone; + } + + /** * Returns the first name. * * @return The first name */ + @Nullable public String getFirstName() { return firstName; } @@ -71,9 +123,12 @@ public class Profile { * * @param firstName * The first name to set + * @return This profile (for method chaining) */ - public void setFirstName(String firstName) { - this.firstName = firstName; + @Nonnull + public Profile setFirstName(@Nullable String firstName) { + this.firstName = "".equals(firstName) ? null : firstName; + return this; } /** @@ -81,6 +136,7 @@ public class Profile { * * @return The middle name */ + @Nullable public String getMiddleName() { return middleName; } @@ -90,9 +146,12 @@ public class Profile { * * @param middleName * The middle name to set + * @return This profile (for method chaining) */ - public void setMiddleName(String middleName) { - this.middleName = middleName; + @Nonnull + public Profile setMiddleName(@Nullable String middleName) { + this.middleName = "".equals(middleName) ? null : middleName; + return this; } /** @@ -100,6 +159,7 @@ public class Profile { * * @return The last name */ + @Nullable public String getLastName() { return lastName; } @@ -109,9 +169,426 @@ public class Profile { * * @param lastName * The last name to set + * @return This profile (for method chaining) */ - public void setLastName(String lastName) { - this.lastName = lastName; + @Nonnull + public Profile setLastName(@Nullable String lastName) { + this.lastName = "".equals(lastName) ? null : lastName; + return this; } + /** + * Returns the day of the birth date. + * + * @return The day of the birth date (from 1 to 31) + */ + @Nullable + public Integer getBirthDay() { + return birthDay; + } + + /** + * Sets the day of the birth date. + * + * @param birthDay + * The day of the birth date (from 1 to 31) + * @return This profile (for method chaining) + */ + @Nonnull + public Profile setBirthDay(@Nullable Integer birthDay) { + this.birthDay = birthDay; + return this; + } + + /** + * Returns the month of the birth date. + * + * @return The month of the birth date (from 1 to 12) + */ + @Nullable + public Integer getBirthMonth() { + return birthMonth; + } + + /** + * Sets the month of the birth date. + * + * @param birthMonth + * The month of the birth date (from 1 to 12) + * @return This profile (for method chaining) + */ + @Nonnull + public Profile setBirthMonth(@Nullable Integer birthMonth) { + this.birthMonth = birthMonth; + return this; + } + + /** + * Returns the year of the birth date. + * + * @return The year of the birth date + */ + @Nullable + public Integer getBirthYear() { + return birthYear; + } + + /** + * Returns the ID of the currently selected avatar image. + * + * @return The ID of the currently selected avatar image, or {@code null} if + * no avatar is selected. + */ + @Nullable + public String getAvatar() { + return avatar; + } + + /** + * Sets the avatar image. + * + * @param avatar + * The new avatar image, or {@code null} to not select an avatar + * image. + * @return This Sone + */ + @Nonnull + public Profile setAvatar(@Nullable Image avatar) { + if (avatar == null) { + this.avatar = null; + return this; + } + checkArgument(avatar.getSone().equals(sone), "avatar must belong to Sone"); + this.avatar = avatar.getId(); + return this; + } + + /** + * Sets the year of the birth date. + * + * @param birthYear + * The year of the birth date + * @return This profile (for method chaining) + */ + @Nonnull + public Profile setBirthYear(@Nullable Integer birthYear) { + this.birthYear = birthYear; + return this; + } + + /** + * Returns the fields of this profile. + * + * @return The fields of this profile + */ + @Nonnull + public List getFields() { + return new ArrayList<>(fields); + } + + /** + * Returns whether this profile contains the given field. + * + * @param field + * The field to check for + * @return {@code true} if this profile contains the field, false otherwise + */ + public boolean hasField(@Nonnull Field field) { + return fields.contains(field); + } + + /** + * Returns the field with the given ID. + * + * @param fieldId + * The ID of the field to get + * @return The field, or {@code null} if this profile does not contain a + * field with the given ID + */ + @Nullable + public Field getFieldById(@Nonnull String fieldId) { + checkNotNull(fieldId, "fieldId must not be null"); + for (Field field : fields) { + if (field.getId().equals(fieldId)) { + return field; + } + } + return null; + } + + /** + * Returns the field with the given name. + * + * @param fieldName + * The name of the field to get + * @return The field, or {@code null} if this profile does not contain a + * field with the given name + */ + @Nullable + public Field getFieldByName(@Nonnull String fieldName) { + for (Field field : fields) { + if (field.getName().equals(fieldName)) { + return field; + } + } + return null; + } + + /** + * Appends a new field to the list of fields. + * + * @param fieldName + * The name of the new field + * @return The new field + * @throws IllegalArgumentException + * if the name is not valid + */ + @Nonnull + public Field addField(@Nonnull String fieldName) throws IllegalArgumentException { + checkNotNull(fieldName, "fieldName must not be null"); + if (fieldName.length() == 0) { + throw new EmptyFieldName(); + } + if (getFieldByName(fieldName) != null) { + throw new DuplicateField(); + } + @SuppressWarnings("synthetic-access") + Field field = new Field().setName(fieldName).setValue(""); + fields.add(field); + return field; + } + + /** + * Moves the given field up one position in the field list. The index of the + * field to move must be greater than {@code 0} (because you obviously can + * not move the first field further up). + * + * @param field + * The field to move up + */ + public void moveFieldUp(@Nonnull Field field) { + checkNotNull(field, "field must not be null"); + checkArgument(hasField(field), "field must belong to this profile"); + checkArgument(getFieldIndex(field) > 0, "field index must be > 0"); + int fieldIndex = getFieldIndex(field); + fields.remove(field); + fields.add(fieldIndex - 1, field); + } + + /** + * Moves the given field down one position in the field list. The index of + * the field to move must be less than the index of the last field (because + * you obviously can not move the last field further down). + * + * @param field + * The field to move down + */ + public void moveFieldDown(@Nonnull Field field) { + checkNotNull(field, "field must not be null"); + checkArgument(hasField(field), "field must belong to this profile"); + checkArgument(getFieldIndex(field) < fields.size() - 1, "field index must be < " + (fields.size() - 1)); + int fieldIndex = getFieldIndex(field); + fields.remove(field); + fields.add(fieldIndex + 1, field); + } + + /** + * Removes the given field. + * + * @param field + * The field to remove + */ + public void removeField(@Nonnull Field field) { + checkNotNull(field, "field must not be null"); + checkArgument(hasField(field), "field must belong to this profile"); + fields.remove(field); + } + + // + // PRIVATE METHODS + // + + /** + * Returns the index of the field with the given name. + * + * @param field + * The name of the field + * @return The index of the field, or {@code -1} if there is no field with + * the given name + */ + private int getFieldIndex(@Nonnull Field field) { + return fields.indexOf(field); + } + + // + // INTERFACE Fingerprintable + // + + /** + * {@inheritDoc} + */ + @Override + public String getFingerprint() { + Hasher hash = Hashing.sha256().newHasher(); + hash.putString("Profile(", UTF_8); + if (firstName != null) { + hash.putString("FirstName(", UTF_8).putString(firstName, UTF_8).putString(")", UTF_8); + } + if (middleName != null) { + hash.putString("MiddleName(", UTF_8).putString(middleName, UTF_8).putString(")", UTF_8); + } + if (lastName != null) { + hash.putString("LastName(", UTF_8).putString(lastName, UTF_8).putString(")", UTF_8); + } + if (birthDay != null) { + hash.putString("BirthDay(", UTF_8).putInt(birthDay).putString(")", UTF_8); + } + if (birthMonth != null) { + hash.putString("BirthMonth(", UTF_8).putInt(birthMonth).putString(")", UTF_8); + } + if (birthYear != null) { + hash.putString("BirthYear(", UTF_8).putInt(birthYear).putString(")", UTF_8); + } + if (avatar != null) { + hash.putString("Avatar(", UTF_8).putString(avatar, UTF_8).putString(")", UTF_8); + } + hash.putString("ContactInformation(", UTF_8); + for (Field field : fields) { + hash.putString(field.getName(), UTF_8).putString("(", UTF_8).putString(field.getValue(), UTF_8).putString(")", UTF_8); + } + hash.putString(")", UTF_8); + hash.putString(")", UTF_8); + + return hash.hash().toString(); + } + + /** + * Container for a profile field. + */ + public class Field { + + /** The ID of the field. */ + private final String id; + + /** The name of the field. */ + private String name; + + /** The value of the field. */ + private String value; + + /** + * Creates a new field with a random ID. + */ + private Field() { + this(UUID.randomUUID().toString()); + } + + /** + * Creates a new field with the given ID. + * + * @param id + * The ID of the field + */ + private Field(@Nonnull String id) { + this.id = checkNotNull(id, "id must not be null"); + } + + /** + * Returns the ID of this field. + * + * @return The ID of this field + */ + @Nonnull + public String getId() { + return id; + } + + /** + * Returns the name of this field. + * + * @return The name of this field + */ + @Nonnull + public String getName() { + return name; + } + + /** + * Sets the name of this field. The name must not be {@code null} and + * must not match any other fields in this profile but my match the name + * of this field. + * + * @param name + * The new name of this field + * @return This field + */ + @Nonnull + public Field setName(@Nonnull String name) { + checkNotNull(name, "name must not be null"); + checkArgument(getFieldByName(name) == null, "name must be unique"); + this.name = name; + return this; + } + + /** + * Returns the value of this field. + * + * @return The value of this field + */ + @Nullable + public String getValue() { + return value; + } + + /** + * Sets the value of this field. While {@code null} is allowed, no + * guarantees are made that {@code null} values are correctly persisted + * across restarts of the plugin! + * + * @param value + * The new value of this field + * @return This field + */ + @Nonnull + public Field setValue(@Nullable String value) { + this.value = value; + return this; + } + + // + // OBJECT METHODS + // + + /** + * {@inheritDoc} + */ + @Override + public boolean equals(Object object) { + if (!(object instanceof Field)) { + return false; + } + Field field = (Field) object; + return id.equals(field.id); + } + + /** + * {@inheritDoc} + */ + @Override + public int hashCode() { + return id.hashCode(); + } + + } + + /** + * Exception that signals the addition of a field with an empty name. + */ + public static class EmptyFieldName extends IllegalArgumentException { } + + /** + * Exception that signals the addition of a field that already exists. + */ + public static class DuplicateField extends IllegalArgumentException { } + }