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=64aeae4ccd212e6c05d54915632590662e352cd5;hb=438378deab1514f0f608d975ef65f5b7aea44ccb;hpb=3abc078471d7e7516599eda01de011a23c328d63 diff --git a/src/main/java/net/pterodactylus/sone/data/Profile.java b/src/main/java/net/pterodactylus/sone/data/Profile.java index 64aeae4..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,23 +17,31 @@ 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.HashMap; -import java.util.LinkedHashMap; import java.util.List; -import java.util.Map; +import java.util.UUID; + +import javax.annotation.Nonnull; +import javax.annotation.Nullable; -import net.pterodactylus.util.validation.Validation; +import com.google.common.hash.Hasher; +import com.google.common.hash.Hashing; /** * 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 implements Fingerprintable { + /** The Sone this profile belongs to. */ + private final Sone sone; + /** The first name. */ private volatile String firstName; @@ -52,17 +60,20 @@ public class Profile implements Fingerprintable { /** The year of the birth date. */ private volatile Integer birthYear; - /** Additional fields in the profile. */ - private final List fields = Collections.synchronizedList(new ArrayList()); + /** The ID of the avatar image. */ + private volatile String avatar; - /** The field values. */ - private final Map fieldValues = Collections.synchronizedMap(new HashMap()); + /** 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; } /** @@ -71,17 +82,16 @@ public class Profile implements Fingerprintable { * @param profile * The profile to copy */ - public Profile(Profile profile) { - if (profile == null) { - return; - } + 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.fieldValues.putAll(profile.fieldValues); + this.avatar = profile.avatar; + this.fields.addAll(profile.fields); } // @@ -89,10 +99,21 @@ public class Profile implements Fingerprintable { // /** + * 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; } @@ -104,8 +125,9 @@ public class Profile implements Fingerprintable { * The first name to set * @return This profile (for method chaining) */ - public Profile setFirstName(String firstName) { - this.firstName = firstName; + @Nonnull + public Profile setFirstName(@Nullable String firstName) { + this.firstName = "".equals(firstName) ? null : firstName; return this; } @@ -114,6 +136,7 @@ public class Profile implements Fingerprintable { * * @return The middle name */ + @Nullable public String getMiddleName() { return middleName; } @@ -125,8 +148,9 @@ public class Profile implements Fingerprintable { * The middle name to set * @return This profile (for method chaining) */ - public Profile setMiddleName(String middleName) { - this.middleName = middleName; + @Nonnull + public Profile setMiddleName(@Nullable String middleName) { + this.middleName = "".equals(middleName) ? null : middleName; return this; } @@ -135,6 +159,7 @@ public class Profile implements Fingerprintable { * * @return The last name */ + @Nullable public String getLastName() { return lastName; } @@ -146,8 +171,9 @@ public class Profile implements Fingerprintable { * The last name to set * @return This profile (for method chaining) */ - public Profile setLastName(String lastName) { - this.lastName = lastName; + @Nonnull + public Profile setLastName(@Nullable String lastName) { + this.lastName = "".equals(lastName) ? null : lastName; return this; } @@ -156,6 +182,7 @@ public class Profile implements Fingerprintable { * * @return The day of the birth date (from 1 to 31) */ + @Nullable public Integer getBirthDay() { return birthDay; } @@ -167,7 +194,8 @@ public class Profile implements Fingerprintable { * The day of the birth date (from 1 to 31) * @return This profile (for method chaining) */ - public Profile setBirthDay(Integer birthDay) { + @Nonnull + public Profile setBirthDay(@Nullable Integer birthDay) { this.birthDay = birthDay; return this; } @@ -177,6 +205,7 @@ public class Profile implements Fingerprintable { * * @return The month of the birth date (from 1 to 12) */ + @Nullable public Integer getBirthMonth() { return birthMonth; } @@ -188,7 +217,8 @@ public class Profile implements Fingerprintable { * The month of the birth date (from 1 to 12) * @return This profile (for method chaining) */ - public Profile setBirthMonth(Integer birthMonth) { + @Nonnull + public Profile setBirthMonth(@Nullable Integer birthMonth) { this.birthMonth = birthMonth; return this; } @@ -198,157 +228,180 @@ public class Profile implements Fingerprintable { * * @return The year of the birth date */ + @Nullable public Integer getBirthYear() { return birthYear; } /** - * Sets the year of the birth date. + * Returns the ID of the currently selected avatar image. * - * @param birthYear - * The year of the birth date - * @return This profile (for method chaining) + * @return The ID of the currently selected avatar image, or {@code null} if + * no avatar is selected. */ - public Profile setBirthYear(Integer birthYear) { - this.birthYear = birthYear; - return this; + @Nullable + public String getAvatar() { + return avatar; } /** - * Appends a new field to the list of fields. + * Sets the avatar image. * - * @param field - * The field to add - * @throws IllegalArgumentException - * if the name is not valid + * @param avatar + * The new avatar image, or {@code null} to not select an avatar + * image. + * @return This Sone */ - public void addField(String field) throws IllegalArgumentException { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Unique", !fields.contains(field), true).check(); - fields.add(field); - } - - /** - * Moves the field with the given index 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 fieldIndex - * The index of the field to move - */ - public void moveFieldUp(int fieldIndex) { - Validation.begin().isGreater("Field Index", fieldIndex, 0).isLess("Field Index", fieldIndex, fields.size()).check(); - String field = fields.remove(fieldIndex); - fields.add(fieldIndex - 1, field); + @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; } /** - * Moves the field with the given name up one position in the field list. - * The field must not be the first field (because you obviously can not move - * the first field further up). + * Sets the year of the birth date. * - * @param field - * The name of the field to move + * @param birthYear + * The year of the birth date + * @return This profile (for method chaining) */ - public void moveFieldUp(String field) { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Existing", fields.contains(field), true).check(); - moveFieldUp(getFieldIndex(field)); + @Nonnull + public Profile setBirthYear(@Nullable Integer birthYear) { + this.birthYear = birthYear; + return this; } /** - * Moves the field with the given index 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). + * Returns the fields of this profile. * - * @param fieldIndex - * The index of the field to move + * @return The fields of this profile */ - public void moveFieldDown(int fieldIndex) { - Validation.begin().isGreaterOrEqual("Field Index", fieldIndex, 0).isLess("Field Index", fieldIndex, fields.size() - 1).check(); - String field = fields.remove(fieldIndex); - fields.add(fieldIndex + 1, field); + @Nonnull + public List getFields() { + return new ArrayList<>(fields); } /** - * Moves the field with the given name down one position in the field list. - * The field must not be the last field (because you obviously can not move - * the last field further down). + * Returns whether this profile contains the given field. * * @param field - * The name of the field to move + * The field to check for + * @return {@code true} if this profile contains the field, false otherwise */ - public void moveFieldDown(String field) { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Existing", fields.contains(field), true).check(); - moveFieldDown(getFieldIndex(field)); + public boolean hasField(@Nonnull Field field) { + return fields.contains(field); } /** - * Removes the field at the given index. + * Returns the field with the given ID. * - * @param fieldIndex - * The index of the field to remove + * @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 */ - public void removeField(int fieldIndex) { - Validation.begin().isGreaterOrEqual("Field Index", fieldIndex, 0).isLess("Field Index", fieldIndex, fields.size()).check(); - String field = fields.remove(fieldIndex); - fieldValues.remove(field); + @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; } /** - * Removes the field with the given name. + * Returns the field with the given name. * - * @param field - * The name of the field + * @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 */ - public void removeField(String field) { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Existing", fields.contains(field), true).check(); - removeField(getFieldIndex(field)); + @Nullable + public Field getFieldByName(@Nonnull String fieldName) { + for (Field field : fields) { + if (field.getName().equals(fieldName)) { + return field; + } + } + return null; } /** - * Returns the value of the field with the given name. + * Appends a new field to the list of fields. * - * @param field - * The name of the field - * @return The value of the field, or {@code null} if there is no such field + * @param fieldName + * The name of the new field + * @return The new field + * @throws IllegalArgumentException + * if the name is not valid */ - public String getField(String field) { - return fieldValues.get(field); + @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; } /** - * Sets the value of the field with the given name. + * 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 name of the field - * @param value - * The value of the field + * The field to move up */ - public void setField(String field, String value) { - Validation.begin().isNotNull("Field Name", field).check().isGreater("Field Name Length", field.length(), 0).isEqual("Field Name Existing", fields.contains(field), true).check(); - fieldValues.put(field, value); + 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); } /** - * Returns a list of all fields stored in this profile. + * 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). * - * @return The fields of this profile + * @param field + * The field to move down */ - public List getFieldNames() { - return Collections.unmodifiableList(fields); + 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); } /** - * Returns all field names and their values, ordered the same way - * {@link #getFieldNames()} returns the names of the fields. + * Removes the given field. * - * @return All field names and values + * @param field + * The field to remove */ - public Map getFields() { - Map fields = new LinkedHashMap(); - for (String field : getFieldNames()) { - fields.put(field, getField(field)); - } - return fields; + 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); } // @@ -363,7 +416,7 @@ public class Profile implements Fingerprintable { * @return The index of the field, or {@code -1} if there is no field with * the given name */ - private int getFieldIndex(String field) { + private int getFieldIndex(@Nonnull Field field) { return fields.indexOf(field); } @@ -376,34 +429,166 @@ public class Profile implements Fingerprintable { */ @Override public String getFingerprint() { - StringBuilder fingerprint = new StringBuilder(); - fingerprint.append("Profile("); + Hasher hash = Hashing.sha256().newHasher(); + hash.putString("Profile(", UTF_8); if (firstName != null) { - fingerprint.append("FirstName(").append(firstName).append(')'); + hash.putString("FirstName(", UTF_8).putString(firstName, UTF_8).putString(")", UTF_8); } if (middleName != null) { - fingerprint.append("MiddleName(").append(middleName).append(')'); + hash.putString("MiddleName(", UTF_8).putString(middleName, UTF_8).putString(")", UTF_8); } if (lastName != null) { - fingerprint.append("LastName(").append(lastName).append(')'); + hash.putString("LastName(", UTF_8).putString(lastName, UTF_8).putString(")", UTF_8); } if (birthDay != null) { - fingerprint.append("BirthDay(").append(birthDay).append(')'); + hash.putString("BirthDay(", UTF_8).putInt(birthDay).putString(")", UTF_8); } if (birthMonth != null) { - fingerprint.append("BirthMonth(").append(birthMonth).append(')'); + hash.putString("BirthMonth(", UTF_8).putInt(birthMonth).putString(")", UTF_8); } if (birthYear != null) { - fingerprint.append("BirthYear(").append(birthYear).append(')'); + 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; } - fingerprint.append("ContactInformation("); - for (String field : fields) { - fingerprint.append(field).append('(').append(fieldValues.get(field)).append(')'); + + /** + * 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(); } - fingerprint.append(")"); - fingerprint.append(")"); - return fingerprint.toString(); } + /** + * 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 { } + }