Return to storing the ID instead of getting it from the identity.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Sone.java
index dd31c03..0afbf3b 100644 (file)
@@ -24,10 +24,10 @@ import java.util.Comparator;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
-import java.util.UUID;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import net.pterodactylus.sone.freenet.wot.Identity;
 import net.pterodactylus.sone.template.SoneAccessor;
 import net.pterodactylus.util.logging.Logging;
 import freenet.keys.FreenetURI;
@@ -42,45 +42,59 @@ import freenet.keys.FreenetURI;
  */
 public class Sone {
 
+       /** comparator that sorts Sones by their nice name. */
+       public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
+
+               @Override
+               public int compare(Sone leftSone, Sone rightSone) {
+                       int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
+                       if (diff != 0) {
+                               return diff;
+                       }
+                       return leftSone.getId().compareToIgnoreCase(rightSone.getId());
+               }
+
+       };
+
        /** The logger. */
        private static final Logger logger = Logging.getLogger(Sone.class);
 
-       /** A GUID for this Sone. */
-       private final UUID id;
+       /** The ID of this Sone. */
+       private final String id;
 
-       /** The name of this Sone. */
-       private String name;
+       /** The identity of this Sone. */
+       private Identity identity;
 
        /** The URI under which the Sone is stored in Freenet. */
-       private FreenetURI requestUri;
+       private volatile FreenetURI requestUri;
 
        /** The URI used to insert a new version of this Sone. */
        /* This will be null for remote Sones! */
-       private FreenetURI insertUri;
+       private volatile FreenetURI insertUri;
+
+       /** The latest edition of the Sone. */
+       private volatile long latestEdition;
 
        /** The time of the last inserted update. */
-       private long time;
+       private volatile long time;
 
        /** The profile of this Sone. */
-       private Profile profile;
+       private volatile Profile profile;
 
        /** All friend Sones. */
-       private final Set<Sone> friendSones = new HashSet<Sone>();
+       private final Set<Sone> friendSones = Collections.synchronizedSet(new HashSet<Sone>());
 
        /** All posts. */
-       private final Set<Post> posts = new HashSet<Post>();
+       private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
 
        /** All replies. */
-       private final Set<Reply> replies = new HashSet<Reply>();
-
-       /** The IDs of all blocked Sones. */
-       private final Set<String> blockedSoneIds = new HashSet<String>();
+       private final Set<Reply> replies = Collections.synchronizedSet(new HashSet<Reply>());
 
        /** The IDs of all liked posts. */
-       private final Set<String> likedPostIds = new HashSet<String>();
+       private final Set<String> likedPostIds = Collections.synchronizedSet(new HashSet<String>());
 
        /** The IDs of all liked replies. */
-       private final Set<String> likedReplyIds = new HashSet<String>();
+       private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
 
        /** Modification count. */
        private volatile long modificationCounter = 0;
@@ -89,10 +103,10 @@ public class Sone {
         * Creates a new Sone.
         *
         * @param id
-        *            The ID of this Sone
+        *            The ID of the Sone
         */
        public Sone(String id) {
-               this.id = UUID.fromString(id);
+               this.id = id;
        }
 
        //
@@ -100,42 +114,57 @@ public class Sone {
        //
 
        /**
-        * Returns the ID of this Sone.
+        * Returns the identity of this Sone.
         *
-        * @return The ID of this Sone
+        * @return The identity of this Sone
         */
        public String getId() {
-               return id.toString();
+               return id;
        }
 
        /**
-        * Returns the name of this Sone.
+        * Returns the identity of this Sone.
         *
-        * @return The name of this Sone
+        * @return The identity of this Sone
         */
-       public String getName() {
-               return name;
+       public Identity getIdentity() {
+               return identity;
        }
 
        /**
-        * Sets the name of this Sone.
+        * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
+        * identity has to match this Sone’s {@link #getId()}.
         *
-        * @param name
-        *            The name of this Sone
-        * @return This sone (for method chaining)
+        * @param identity
+        *            The identity of this Sone
+        * @return This Sone (for method chaining)
+        * @throws IllegalArgumentException
+        *             if the ID of the identity does not match this Sone’s ID
         */
-       public Sone setName(String name) {
-               this.name = name;
+       public Sone setIdentity(Identity identity) throws IllegalArgumentException {
+               if (!identity.getId().equals(id)) {
+                       throw new IllegalArgumentException("Identity’s ID does not match Sone’s ID!");
+               }
+               this.identity = identity;
                return this;
        }
 
        /**
+        * Returns the name of this Sone.
+        *
+        * @return The name of this Sone
+        */
+       public String getName() {
+               return (identity != null) ? identity.getNickname() : null;
+       }
+
+       /**
         * Returns the request URI of this Sone.
         *
         * @return The request URI of this Sone
         */
        public FreenetURI getRequestUri() {
-               return requestUri;
+               return requestUri.setSuggestedEdition(latestEdition);
        }
 
        /**
@@ -146,7 +175,15 @@ public class Sone {
         * @return This Sone (for method chaining)
         */
        public Sone setRequestUri(FreenetURI requestUri) {
-               this.requestUri = requestUri;
+               if (this.requestUri == null) {
+                       this.requestUri = requestUri.setDocName("Sone").setMetaString(new String[0]);
+                       return this;
+               }
+               if (!this.requestUri.equalsKeypair(requestUri)) {
+                       logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { requestUri, this.requestUri });
+                       return this;
+               }
+               setLatestEdition(requestUri.getEdition());
                return this;
        }
 
@@ -156,7 +193,7 @@ public class Sone {
         * @return The insert URI of this Sone
         */
        public FreenetURI getInsertUri() {
-               return insertUri;
+               return insertUri.setSuggestedEdition(latestEdition);
        }
 
        /**
@@ -167,11 +204,44 @@ public class Sone {
         * @return This Sone (for method chaining)
         */
        public Sone setInsertUri(FreenetURI insertUri) {
-               this.insertUri = insertUri;
+               if (this.insertUri == null) {
+                       this.insertUri = insertUri.setDocName("Sone").setMetaString(new String[0]);
+                       return this;
+               }
+               if (!this.insertUri.equalsKeypair(insertUri)) {
+                       logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { insertUri, this.insertUri });
+                       return this;
+               }
+               setLatestEdition(insertUri.getEdition());
                return this;
        }
 
        /**
+        * Returns the latest edition of this Sone.
+        *
+        * @return The latest edition of this Sone
+        */
+       public long getLatestEdition() {
+               return latestEdition;
+       }
+
+       /**
+        * Sets the latest edition of this Sone. If the given latest edition is not
+        * greater than the current latest edition, the latest edition of this Sone
+        * is not changed.
+        *
+        * @param latestEdition
+        *            The latest edition of this Sone
+        */
+       public void setLatestEdition(long latestEdition) {
+               if (!(latestEdition > this.latestEdition)) {
+                       logger.log(Level.INFO, "New latest edition %d is not greater than current latest edition %d!", new Object[] { latestEdition, this.latestEdition });
+                       return;
+               }
+               this.latestEdition = latestEdition;
+       }
+
+       /**
         * Return the time of the last inserted update of this Sone.
         *
         * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
@@ -396,52 +466,6 @@ public class Sone {
        }
 
        /**
-        * Returns the IDs of all blocked Sones. These Sones will not propagated
-        * using the “known Sones” mechanism.
-        *
-        * @return The IDs of all blocked Sones
-        */
-       public Set<String> getBlockedSoneIds() {
-               return Collections.unmodifiableSet(blockedSoneIds);
-       }
-
-       /**
-        * Returns whether the given Sone ID is blocked.
-        *
-        * @param soneId
-        *            The Sone ID to check
-        * @return {@code true} if the given Sone ID is blocked, {@code false}
-        *         otherwise
-        */
-       public boolean isSoneBlocked(String soneId) {
-               return blockedSoneIds.contains(soneId);
-       }
-
-       /**
-        * Adds the given ID to the list of blocked IDs.
-        *
-        * @param soneId
-        *            The Sone ID to block
-        */
-       public synchronized void addBlockedSoneId(String soneId) {
-               if (blockedSoneIds.add(soneId)) {
-                       modificationCounter++;
-               }
-       }
-
-       /**
-        * Removes the given ID from the list of blocked IDs.
-        *
-        * @param soneId
-        *            The Sone ID to unblock
-        */
-       public synchronized void removeBlockedSoneId(String soneId) {
-               if (blockedSoneIds.remove(soneId)) {
-                       modificationCounter++;
-               }
-       }
-
-       /**
         * Returns the IDs of all liked posts.
         *
         * @return All liked posts’ IDs
@@ -586,21 +610,6 @@ public class Sone {
                this.modificationCounter = modificationCounter;
        }
 
-       /**
-        * Updates the suggested edition in both the request URI and the insert URI.
-        *
-        * @param requestUri
-        *            The request URI that resulted from an insert
-        */
-       public void updateUris(FreenetURI requestUri) {
-               /* TODO - check for the correct URI. */
-               long latestEdition = requestUri.getSuggestedEdition();
-               this.requestUri = this.requestUri.setSuggestedEdition(latestEdition);
-               if (this.insertUri != null) {
-                       this.insertUri = this.insertUri.setSuggestedEdition(latestEdition);
-               }
-       }
-
        //
        // OBJECT METHODS
        //
@@ -629,7 +638,7 @@ public class Sone {
         */
        @Override
        public String toString() {
-               return getClass().getName() + "[id=" + id + ",name=" + name + ",requestUri=" + requestUri + ",insertUri=" + insertUri + ",friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
+               return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri=" + insertUri + ",friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
        }
 
 }