Return to storing the ID instead of getting it from the identity.
[Sone.git] / src / main / java / net / pterodactylus / sone / data / Sone.java
index 7041289..0afbf3b 100644 (file)
 package net.pterodactylus.sone.data;
 
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 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;
 
@@ -40,33 +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 final 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 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 List<Post> posts = new ArrayList<Post>();
+       private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
 
        /** All replies. */
-       private final Set<Reply> replies = new HashSet<Reply>();
+       private final Set<Reply> replies = Collections.synchronizedSet(new HashSet<Reply>());
+
+       /** The IDs of all liked posts. */
+       private final Set<String> likedPostIds = Collections.synchronizedSet(new HashSet<String>());
+
+       /** The IDs of all liked replies. */
+       private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
 
        /** Modification count. */
        private volatile long modificationCounter = 0;
@@ -75,33 +103,10 @@ public class Sone {
         * Creates a new Sone.
         *
         * @param id
-        *            The ID of this Sone
-        * @param name
-        *            The name of the Sone
-        * @param requestUri
-        *            The request URI of the Sone
+        *            The ID of the Sone
         */
-       public Sone(UUID id, String name, FreenetURI requestUri) {
-               this(id, name, requestUri, null);
-       }
-
-       /**
-        * Creates a new Sone.
-        *
-        * @param id
-        *            The ID of this Sone
-        * @param name
-        *            The name of the Sone
-        * @param requestUri
-        *            The request URI of the Sone
-        * @param insertUri
-        *            The insert URI of the Sone
-        */
-       public Sone(UUID id, String name, FreenetURI requestUri, FreenetURI insertUri) {
+       public Sone(String id) {
                this.id = id;
-               this.name = name;
-               this.requestUri = requestUri;
-               this.insertUri = insertUri;
        }
 
        //
@@ -109,12 +114,39 @@ 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 identity of this Sone.
+        *
+        * @return The identity of this Sone
+        */
+       public Identity getIdentity() {
+               return identity;
+       }
+
+       /**
+        * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
+        * identity has to match this Sone’s {@link #getId()}.
+        *
+        * @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 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;
        }
 
        /**
@@ -123,7 +155,7 @@ public class Sone {
         * @return The name of this Sone
         */
        public String getName() {
-               return name;
+               return (identity != null) ? identity.getNickname() : null;
        }
 
        /**
@@ -132,7 +164,27 @@ public class Sone {
         * @return The request URI of this Sone
         */
        public FreenetURI getRequestUri() {
-               return requestUri;
+               return requestUri.setSuggestedEdition(latestEdition);
+       }
+
+       /**
+        * Sets the request URI of this Sone.
+        *
+        * @param requestUri
+        *            The request URI of this Sone
+        * @return This Sone (for method chaining)
+        */
+       public Sone setRequestUri(FreenetURI 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;
        }
 
        /**
@@ -141,7 +193,73 @@ public class Sone {
         * @return The insert URI of this Sone
         */
        public FreenetURI getInsertUri() {
-               return insertUri;
+               return insertUri.setSuggestedEdition(latestEdition);
+       }
+
+       /**
+        * Sets the insert URI of this Sone.
+        *
+        * @param insertUri
+        *            The insert URI of this Sone
+        * @return This Sone (for method chaining)
+        */
+       public Sone setInsertUri(FreenetURI 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)
+        */
+       public long getTime() {
+               return time;
+       }
+
+       /**
+        * Sets the time of the last inserted update of this Sone.
+        *
+        * @param time
+        *            The time of the update (in milliseconds since Jan 1, 1970 UTC)
+        * @return This Sone (for method chaining)
+        */
+       public Sone setTime(long time) {
+               this.time = time;
+               return this;
        }
 
        /**
@@ -173,8 +291,33 @@ public class Sone {
         *
         * @return The friend Sones of this Sone
         */
-       public Set<Sone> getFriends() {
-               return Collections.unmodifiableSet(friendSones);
+       public List<Sone> getFriends() {
+               List<Sone> friends = new ArrayList<Sone>(friendSones);
+               Collections.sort(friends, 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 (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightSone.getTime() - leftSone.getTime()));
+                       }
+               });
+               return friends;
+       }
+
+       /**
+        * Sets all friends of this Sone at once.
+        *
+        * @param friends
+        *            The new (and only) friends of this Sone
+        * @return This Sone (for method chaining)
+        */
+       public Sone setFriends(Collection<Sone> friends) {
+               friendSones.clear();
+               friendSones.addAll(friends);
+               return this;
        }
 
        /**
@@ -196,9 +339,9 @@ public class Sone {
         *            The friend Sone to add
         * @return This Sone (for method chaining)
         */
-       public synchronized Sone addFriend(Sone friendSone) {
-               if (friendSones.add(friendSone)) {
-                       modificationCounter++;
+       public Sone addFriend(Sone friendSone) {
+               if (!friendSone.equals(this)) {
+                       friendSones.add(friendSone);
                }
                return this;
        }
@@ -210,10 +353,8 @@ public class Sone {
         *            The friend Sone to remove
         * @return This Sone (for method chaining)
         */
-       public synchronized Sone removeFriend(Sone friendSone) {
-               if (friendSones.remove(friendSone)) {
-                       modificationCounter++;
-               }
+       public Sone removeFriend(Sone friendSone) {
+               friendSones.remove(friendSone);
                return this;
        }
 
@@ -236,6 +377,20 @@ public class Sone {
        }
 
        /**
+        * Sets all posts of this Sone at once.
+        *
+        * @param posts
+        *            The new (and only) posts of this Sone
+        * @return This Sone (for method chaining)
+        */
+       public synchronized Sone setPosts(Collection<Post> posts) {
+               this.posts.clear();
+               this.posts.addAll(posts);
+               modificationCounter++;
+               return this;
+       }
+
+       /**
         * Adds the given post to this Sone. The post will not be added if its
         * {@link Post#getSone() Sone} is not this Sone.
         *
@@ -267,10 +422,25 @@ public class Sone {
         * @return All replies this Sone made
         */
        public Set<Reply> getReplies() {
+               logger.log(Level.FINEST, "Friends of %s: %s", new Object[] { this, friendSones });
                return Collections.unmodifiableSet(replies);
        }
 
        /**
+        * Sets all replies of this Sone at once.
+        *
+        * @param replies
+        *            The new (and only) replies of this Sone
+        * @return This Sone (for method chaining)
+        */
+       public synchronized Sone setReplies(Collection<Reply> replies) {
+               this.replies.clear();
+               this.replies.addAll(replies);
+               modificationCounter++;
+               return this;
+       }
+
+       /**
         * Adds a reply to this Sone. If the given reply was not made by this Sone,
         * nothing is added to this Sone.
         *
@@ -296,6 +466,132 @@ public class Sone {
        }
 
        /**
+        * Returns the IDs of all liked posts.
+        *
+        * @return All liked posts’ IDs
+        */
+       public Set<String> getLikedPostIds() {
+               return Collections.unmodifiableSet(likedPostIds);
+       }
+
+       /**
+        * Sets the IDs of all liked posts.
+        *
+        * @param likedPostIds
+        *            All liked posts’ IDs
+        * @return This Sone (for method chaining)
+        */
+       public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
+               this.likedPostIds.clear();
+               this.likedPostIds.addAll(likedPostIds);
+               modificationCounter++;
+               return this;
+       }
+
+       /**
+        * Checks whether the given post ID is liked by this Sone.
+        *
+        * @param postId
+        *            The ID of the post
+        * @return {@code true} if this Sone likes the given post, {@code false}
+        *         otherwise
+        */
+       public boolean isLikedPostId(String postId) {
+               return likedPostIds.contains(postId);
+       }
+
+       /**
+        * Adds the given post ID to the list of posts this Sone likes.
+        *
+        * @param postId
+        *            The ID of the post
+        * @return This Sone (for method chaining)
+        */
+       public synchronized Sone addLikedPostId(String postId) {
+               if (likedPostIds.add(postId)) {
+                       modificationCounter++;
+               }
+               return this;
+       }
+
+       /**
+        * Removes the given post ID from the list of posts this Sone likes.
+        *
+        * @param postId
+        *            The ID of the post
+        * @return This Sone (for method chaining)
+        */
+       public synchronized Sone removeLikedPostId(String postId) {
+               if (likedPostIds.remove(postId)) {
+                       modificationCounter++;
+               }
+               return this;
+       }
+
+       /**
+        * Returns the IDs of all liked replies.
+        *
+        * @return All liked replies’ IDs
+        */
+       public Set<String> getLikedReplyIds() {
+               return Collections.unmodifiableSet(likedReplyIds);
+       }
+
+       /**
+        * Sets the IDs of all liked replies.
+        *
+        * @param likedReplyIds
+        *            All liked replies’ IDs
+        * @return This Sone (for method chaining)
+        */
+       public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
+               this.likedReplyIds.clear();
+               this.likedReplyIds.addAll(likedReplyIds);
+               modificationCounter++;
+               return this;
+       }
+
+       /**
+        * Checks whether the given reply ID is liked by this Sone.
+        *
+        * @param replyId
+        *            The ID of the reply
+        * @return {@code true} if this Sone likes the given reply, {@code false}
+        *         otherwise
+        */
+       public boolean isLikedReplyId(String replyId) {
+               return likedReplyIds.contains(replyId);
+       }
+
+       /**
+        * Adds the given reply ID to the list of replies this Sone likes.
+        *
+        * @param replyId
+        *            The ID of the reply
+        * @return This Sone (for method chaining)
+        */
+       public synchronized Sone addLikedReplyId(String replyId) {
+               if (likedReplyIds.add(replyId)) {
+                       modificationCounter++;
+               }
+               return this;
+       }
+
+       /**
+        * Removes the given post ID from the list of replies this Sone likes.
+        *
+        * @param replyId
+        *            The ID of the reply
+        * @return This Sone (for method chaining)
+        */
+       public synchronized Sone removeLikedReplyId(String replyId) {
+               if (likedReplyIds.remove(replyId)) {
+                       modificationCounter++;
+               }
+               return this;
+       }
+
+       /**
         * Returns the modification counter.
         *
         * @return The modification counter
@@ -314,19 +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);
-               this.insertUri = this.insertUri.setSuggestedEdition(latestEdition);
-       }
-
        //
        // OBJECT METHODS
        //
@@ -355,7 +638,7 @@ public class Sone {
         */
        @Override
        public String toString() {
-               return getClass().getName() + "[id=" + getId() + ",name=" + getName() + ",requestUri=" + getRequestUri() + ",insertUri=" + getInsertUri() + ",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() + ")]";
        }
 
 }