Merge branch 'next' into profile-fields
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Wed, 12 Jan 2011 12:44:07 +0000 (13:44 +0100)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Wed, 12 Jan 2011 12:44:07 +0000 (13:44 +0100)
src/main/java/net/pterodactylus/sone/core/Core.java
src/main/java/net/pterodactylus/sone/data/Fingerprintable.java [new file with mode: 0644]
src/main/java/net/pterodactylus/sone/data/Profile.java
src/main/java/net/pterodactylus/sone/data/Sone.java
src/main/java/net/pterodactylus/sone/web/EditProfilePage.java
src/main/resources/i18n/sone.en.properties
src/main/resources/templates/editProfile.html
src/main/resources/templates/viewSone.html

index 78df9ef..7cbce1b 100644 (file)
@@ -24,6 +24,7 @@ import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -1033,6 +1034,22 @@ public class Core implements IdentityListener, UpdateListener {
                profile.setBirthMonth(configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").getValue(null));
                profile.setBirthYear(configuration.getIntValue(sonePrefix + "/Profile/BirthYear").getValue(null));
 
+               /* load profile fields. */
+               while (true) {
+                       String fieldPrefix = sonePrefix + "/Profile/Fields/" + profile.getFieldNames().size();
+                       String fieldName = configuration.getStringValue(fieldPrefix + "/Name").getValue(null);
+                       if (fieldName == null) {
+                               break;
+                       }
+                       String fieldValue = configuration.getStringValue(fieldPrefix + "/Value").getValue(null);
+                       if (fieldValue == null) {
+                               logger.log(Level.WARNING, "Invalid profile field found, aborting load!");
+                               return;
+                       }
+                       profile.addField(fieldName);
+                       profile.setField(fieldName, fieldValue);
+               }
+
                /* load posts. */
                Set<Post> posts = new HashSet<Post>();
                while (true) {
@@ -1165,6 +1182,15 @@ public class Core implements IdentityListener, UpdateListener {
                        configuration.getIntValue(sonePrefix + "/Profile/BirthMonth").setValue(profile.getBirthMonth());
                        configuration.getIntValue(sonePrefix + "/Profile/BirthYear").setValue(profile.getBirthYear());
 
+                       /* save profile fields. */
+                       int fieldCounter = 0;
+                       for (Entry<String, String> profileField : profile.getFields().entrySet()) {
+                               String fieldPrefix = sonePrefix + "/Profile/Fields/" + fieldCounter++;
+                               configuration.getStringValue(fieldPrefix + "/Name").setValue(profileField.getKey());
+                               configuration.getStringValue(fieldPrefix + "/Value").setValue(profileField.getValue());
+                       }
+                       configuration.getStringValue(sonePrefix + "/Profile/Fields/" + fieldCounter + "/Name").setValue(null);
+
                        /* save posts. */
                        int postCounter = 0;
                        for (Post post : sone.getPosts()) {
diff --git a/src/main/java/net/pterodactylus/sone/data/Fingerprintable.java b/src/main/java/net/pterodactylus/sone/data/Fingerprintable.java
new file mode 100644 (file)
index 0000000..013e0b3
--- /dev/null
@@ -0,0 +1,36 @@
+/*
+ * Sone - Fingerprintable.java - Copyright © 2011 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.data;
+
+/**
+ * Interface for objects that can create a fingerprint of themselves, e.g. to
+ * detect modifications. The fingerprint should only contain original
+ * information; derived information should not be included.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface Fingerprintable {
+
+       /**
+        * Returns the fingerprint of this object.
+        *
+        * @return The fingerprint of this object
+        */
+       public String getFingerprint();
+
+}
index 7c29430..0c86732 100644 (file)
 
 package net.pterodactylus.sone.data;
 
+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 net.pterodactylus.util.validation.Validation;
+
 /**
  * A profile stores personal information about a {@link Sone}. All information
  * is optional and can be {@code null}.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class Profile {
-
-       /** Whether the profile was modified. */
-       private volatile boolean modified;
+public class Profile implements Fingerprintable {
 
        /** The first name. */
        private volatile String firstName;
@@ -46,6 +52,12 @@ public class Profile {
        /** The year of the birth date. */
        private volatile Integer birthYear;
 
+       /** Additional fields in the profile. */
+       private final List<String> fields = Collections.synchronizedList(new ArrayList<String>());
+
+       /** The field values. */
+       private final Map<String, String> fieldValues = Collections.synchronizedMap(new HashMap<String, String>());
+
        /**
         * Creates a new empty profile.
         */
@@ -69,6 +81,7 @@ public class Profile {
                this.birthDay = profile.birthDay;
                this.birthMonth = profile.birthMonth;
                this.birthYear = profile.birthYear;
+               this.fieldValues.putAll(profile.fieldValues);
        }
 
        //
@@ -76,18 +89,6 @@ public class Profile {
        //
 
        /**
-        * Returns whether this profile was modified after creation. To clear the
-        * “is modified” flag you need to create a new profile from this one using
-        * the {@link #Profile(Profile)} constructor.
-        *
-        * @return {@code true} if this profile was modified after creation,
-        *         {@code false} otherwise
-        */
-       public boolean isModified() {
-               return modified;
-       }
-
-       /**
         * Returns the first name.
         *
         * @return The first name
@@ -104,7 +105,6 @@ public class Profile {
         * @return This profile (for method chaining)
         */
        public Profile setFirstName(String firstName) {
-               modified |= ((firstName != null) && (!firstName.equals(this.firstName))) || (this.firstName != null);
                this.firstName = firstName;
                return this;
        }
@@ -126,7 +126,6 @@ public class Profile {
         * @return This profile (for method chaining)
         */
        public Profile setMiddleName(String middleName) {
-               modified |= ((middleName != null) && (!middleName.equals(this.middleName))) || (this.middleName != null);
                this.middleName = middleName;
                return this;
        }
@@ -148,7 +147,6 @@ public class Profile {
         * @return This profile (for method chaining)
         */
        public Profile setLastName(String lastName) {
-               modified |= ((lastName != null) && (!lastName.equals(this.lastName))) || (this.lastName != null);
                this.lastName = lastName;
                return this;
        }
@@ -170,7 +168,6 @@ public class Profile {
         * @return This profile (for method chaining)
         */
        public Profile setBirthDay(Integer birthDay) {
-               modified |= ((birthDay != null) && (!birthDay.equals(this.birthDay))) || (this.birthDay != null);
                this.birthDay = birthDay;
                return this;
        }
@@ -192,7 +189,6 @@ public class Profile {
         * @return This profile (for method chaining)
         */
        public Profile setBirthMonth(Integer birthMonth) {
-               modified |= ((birthMonth != null) && (!birthMonth.equals(this.birthMonth))) || (this.birthMonth != null);
                this.birthMonth = birthMonth;
                return this;
        }
@@ -214,9 +210,213 @@ public class Profile {
         * @return This profile (for method chaining)
         */
        public Profile setBirthYear(Integer birthYear) {
-               modified |= ((birthYear != null) && (!birthYear.equals(this.birthYear))) || (this.birthYear != null);
                this.birthYear = birthYear;
                return this;
        }
 
+       /**
+        * Appends a new field to the list of fields.
+        *
+        * @param field
+        *            The field to add
+        * @throws IllegalArgumentException
+        *             if the name is not valid
+        */
+       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);
+       }
+
+       /**
+        * 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).
+        *
+        * @param field
+        *            The name of the field to move
+        */
+       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));
+       }
+
+       /**
+        * 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).
+        *
+        * @param fieldIndex
+        *            The index of the field to move
+        */
+       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);
+       }
+
+       /**
+        * 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).
+        *
+        * @param field
+        *            The name of the field to move
+        */
+       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));
+       }
+
+       /**
+        * Removes the field at the given index.
+        *
+        * @param fieldIndex
+        *            The index of the field to remove
+        */
+       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);
+       }
+
+       /**
+        * Removes the field with the given name.
+        *
+        * @param field
+        *            The name of the field
+        */
+       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));
+       }
+
+       /**
+        * Returns the value of the field with the given name.
+        *
+        * @param field
+        *            The name of the field
+        * @return The value of the field, or {@code null} if there is no such field
+        */
+       public String getField(String field) {
+               return fieldValues.get(field);
+       }
+
+       /**
+        * Sets the value of the field with the given name.
+        *
+        * @param fieldIndex
+        *            The index of the field
+        * @param value
+        *            The value of the field
+        */
+       public void setField(int fieldIndex, String value) {
+               Validation.begin().isGreaterOrEqual("Field Index", fieldIndex, 0).isLess("Field Index", fieldIndex, fields.size()).check();
+               setField(fields.get(fieldIndex), value);
+       }
+
+       /**
+        * Sets the value of the field with the given name.
+        *
+        * @param field
+        *            The name of the field
+        * @param value
+        *            The value of the field
+        */
+       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);
+       }
+
+       /**
+        * Returns a list of all fields stored in this profile.
+        *
+        * @return The fields of this profile
+        */
+       public List<String> getFieldNames() {
+               return Collections.unmodifiableList(fields);
+       }
+
+       /**
+        * Returns all field names and their values, ordered the same way
+        * {@link #getFieldNames()} returns the names of the fields.
+        *
+        * @return All field names and values
+        */
+       public Map<String, String> getFields() {
+               Map<String, String> fields = new LinkedHashMap<String, String>();
+               for (String field : getFieldNames()) {
+                       fields.put(field, getField(field));
+               }
+               return fields;
+       }
+
+       //
+       // 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(String field) {
+               return fields.indexOf(field);
+       }
+
+       //
+       // INTERFACE Fingerprintable
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public String getFingerprint() {
+               StringBuilder fingerprint = new StringBuilder();
+               fingerprint.append("Profile(");
+               if (firstName != null) {
+                       fingerprint.append("FirstName(").append(firstName).append(')');
+               }
+               if (middleName != null) {
+                       fingerprint.append("MiddleName(").append(middleName).append(')');
+               }
+               if (lastName != null) {
+                       fingerprint.append("LastName(").append(lastName).append(')');
+               }
+               if (birthDay != null) {
+                       fingerprint.append("BirthDay(").append(birthDay).append(')');
+               }
+               if (birthMonth != null) {
+                       fingerprint.append("BirthMonth(").append(birthMonth).append(')');
+               }
+               if (birthYear != null) {
+                       fingerprint.append("BirthYear(").append(birthYear).append(')');
+               }
+               fingerprint.append("ContactInformation(");
+               for (String field : fields) {
+                       fingerprint.append(field).append('(').append(fieldValues.get(field)).append(')');
+               }
+               fingerprint.append(")");
+               fingerprint.append(")");
+
+               return fingerprint.toString();
+       }
+
 }
index 7d4f7ef..03dff75 100644 (file)
@@ -40,7 +40,7 @@ import freenet.keys.FreenetURI;
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
-public class Sone {
+public class Sone implements Fingerprintable {
 
        /** comparator that sorts Sones by their nice name. */
        public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
@@ -580,36 +580,17 @@ public class Sone {
                return this;
        }
 
+       //
+       // FINGERPRINTABLE METHODS
+       //
+
        /**
-        * Returns a fingerprint of this Sone. The fingerprint only depends on data
-        * that is actually stored when a Sone is inserted. The fingerprint can be
-        * used to detect changes in Sone data and can also be used to detect if
-        * previous changes are reverted.
-        *
-        * @return The fingerprint of this Sone
+        * {@inheritDoc}
         */
+       @Override
        public synchronized String getFingerprint() {
                StringBuilder fingerprint = new StringBuilder();
-               fingerprint.append("Profile(");
-               if (profile.getFirstName() != null) {
-                       fingerprint.append("FirstName(").append(profile.getFirstName()).append(')');
-               }
-               if (profile.getMiddleName() != null) {
-                       fingerprint.append("MiddleName(").append(profile.getMiddleName()).append(')');
-               }
-               if (profile.getLastName() != null) {
-                       fingerprint.append("LastName(").append(profile.getLastName()).append(')');
-               }
-               if (profile.getBirthDay() != null) {
-                       fingerprint.append("BirthDay(").append(profile.getBirthDay()).append(')');
-               }
-               if (profile.getBirthMonth() != null) {
-                       fingerprint.append("BirthMonth(").append(profile.getBirthMonth()).append(')');
-               }
-               if (profile.getBirthYear() != null) {
-                       fingerprint.append("BirthYear(").append(profile.getBirthYear()).append(')');
-               }
-               fingerprint.append(")");
+               fingerprint.append(profile.getFingerprint());
 
                fingerprint.append("Posts(");
                for (Post post : getPosts()) {
index 01d4815..5b2c301 100644 (file)
@@ -64,20 +64,20 @@ public class EditProfilePage extends SoneTemplatePage {
                Integer birthMonth = profile.getBirthMonth();
                Integer birthYear = profile.getBirthYear();
                if (request.getMethod() == Method.POST) {
-                       firstName = request.getHttpRequest().getPartAsStringFailsafe("first-name", 256).trim();
-                       middleName = request.getHttpRequest().getPartAsStringFailsafe("middle-name", 256).trim();
-                       lastName = request.getHttpRequest().getPartAsStringFailsafe("last-name", 256).trim();
-                       birthDay = Numbers.safeParseInteger(request.getHttpRequest().getPartAsStringFailsafe("birth-day", 256).trim());
-                       birthMonth = Numbers.safeParseInteger(request.getHttpRequest().getPartAsStringFailsafe("birth-month", 256).trim());
-                       birthYear = Numbers.safeParseInteger(request.getHttpRequest().getPartAsStringFailsafe("birth-year", 256).trim());
-                       profile.setFirstName(firstName.length() > 0 ? firstName : null);
-                       profile.setMiddleName(middleName.length() > 0 ? middleName : null);
-                       profile.setLastName(lastName.length() > 0 ? lastName : null);
-                       profile.setBirthDay(birthDay).setBirthMonth(birthMonth).setBirthYear(birthYear);
-                       if (profile.isModified()) {
+                       if (request.getHttpRequest().getPartAsStringFailsafe("saveProfile", 4).equals("true")) {
+                               firstName = request.getHttpRequest().getPartAsStringFailsafe("first-name", 256).trim();
+                               middleName = request.getHttpRequest().getPartAsStringFailsafe("middle-name", 256).trim();
+                               lastName = request.getHttpRequest().getPartAsStringFailsafe("last-name", 256).trim();
+                               birthDay = Numbers.safeParseInteger(request.getHttpRequest().getPartAsStringFailsafe("birth-day", 256).trim());
+                               birthMonth = Numbers.safeParseInteger(request.getHttpRequest().getPartAsStringFailsafe("birth-month", 256).trim());
+                               birthYear = Numbers.safeParseInteger(request.getHttpRequest().getPartAsStringFailsafe("birth-year", 256).trim());
+                               profile.setFirstName(firstName.length() > 0 ? firstName : null);
+                               profile.setMiddleName(middleName.length() > 0 ? middleName : null);
+                               profile.setLastName(lastName.length() > 0 ? lastName : null);
+                               profile.setBirthDay(birthDay).setBirthMonth(birthMonth).setBirthYear(birthYear);
                                currentSone.setProfile(profile);
+                               throw new RedirectException("index.html");
                        }
-                       throw new RedirectException("index.html");
                }
                dataProvider.set("firstName", firstName);
                dataProvider.set("middleName", middleName);
index 740cf45..91b39a8 100644 (file)
@@ -92,6 +92,8 @@ Page.ViewSone.UnknownSone.Description=This Sone has not yet been retrieved. Plea
 Page.ViewSone.WriteAMessage=You can write a message to this Sone here. Please note that everybody will be able to read this message!
 Page.ViewSone.PostList.Title=Posts by {sone}
 Page.ViewSone.PostList.Text.NoPostYet=This Sone has not yet posted anything.
+Page.ViewSone.Profile.Title=Profile
+Page.ViewSone.Profile.Label.Name=Name
 
 Page.ViewPost.Title=View Post - Sone
 Page.ViewPost.Page.Title=View Post by {sone}
index d1d5943..d2dc61a 100644 (file)
@@ -71,7 +71,7 @@
                </div>
 
                <div>
-                       <button type="submit"><%= Page.EditProfile.Button.Save|l10n|html></button>
+                       <button type="submit" name="saveProfile" value="true"><%= Page.EditProfile.Button.Save|l10n|html></button>
                </div>
 
        </form>
index 884fa0f..92c9b37 100644 (file)
 
                <%if ! sone.current>
                        <%include include/viewSone.html>
+               <%/if>
+
+               <h1><%= Page.ViewSone.Profile.Title|l10n|html></h1>
 
+                       <div class="profile-field">
+                               <div class="field-name"><%= Page.ViewSone.Profile.Label.Name|l10n|html></div>
+                               <div class="field-value"><% sone.niceName|html></div>
+                       </div>
+
+                       <%foreach sone.profile.fields field>
+                               <div class="profile-field">
+                                       <div class="field-name"><% field.key|html></div>
+                                       <div class="field-value"><% field.value|html></div>
+                               </div>
+                       <%/foreach>
+
+               <%if ! sone.current>
                        <p><%= Page.ViewSone.WriteAMessage|l10n|html></p>
 
                        <form action="createPost.html" id="post-message" method="post">
@@ -31,7 +47,6 @@
                        </form>
                <%/if>
 
-
                <h1><%= Page.ViewSone.PostList.Title|l10n|insert needle="{sone}" key=sone.niceName|html></h1>
 
                <div id="posts">