X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FSone.java;h=3477346f3aedeabde70d4972d3a35214645cff82;hb=45f92ec63dbf8134d92ceed67294faa38117b195;hp=3e808a80da71513d09a628e35a6ad7a5a3c937c5;hpb=7c85033af8457c99cb87feb930f228de0abf70fe;p=Sone.git
diff --git a/src/main/java/net/pterodactylus/sone/data/Sone.java b/src/main/java/net/pterodactylus/sone/data/Sone.java
index 3e808a8..3477346 100644
--- a/src/main/java/net/pterodactylus/sone/data/Sone.java
+++ b/src/main/java/net/pterodactylus/sone/data/Sone.java
@@ -1,5 +1,5 @@
/*
- * FreenetSone - Sone.java - Copyright © 2010 David Roden
+ * Sone - Sone.java - Copyright © 2010 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
@@ -24,10 +24,15 @@ 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.core.Core;
+import net.pterodactylus.sone.core.Options;
+import net.pterodactylus.sone.freenet.wot.Identity;
+import net.pterodactylus.sone.freenet.wot.OwnIdentity;
+import net.pterodactylus.sone.template.SoneAccessor;
+import net.pterodactylus.util.filter.Filter;
import net.pterodactylus.util.logging.Logging;
import freenet.keys.FreenetURI;
@@ -39,53 +44,118 @@ import freenet.keys.FreenetURI;
*
* @author David âBombeâ Roden
*/
-public class Sone {
+public class Sone implements Fingerprintable, Comparable {
+
+ /** comparator that sorts Sones by their nice name. */
+ public static final Comparator NICE_NAME_COMPARATOR = new Comparator() {
+
+ @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());
+ }
+
+ };
+
+ /**
+ * Comparator that sorts Sones by last activity (least recent active first).
+ */
+ public static final Comparator LAST_ACTIVITY_COMPARATOR = new Comparator() {
+
+ @Override
+ public int compare(Sone firstSone, Sone secondSone) {
+ return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
+ }
+ };
+
+ /** Comparator that sorts Sones by numbers of posts (descending). */
+ public static final Comparator POST_COUNT_COMPARATOR = new Comparator() {
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public int compare(Sone leftSone, Sone rightSone) {
+ return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size());
+ }
+ };
+
+ /** Filter to remove Sones that have not been downloaded. */
+ public static final Filter EMPTY_SONE_FILTER = new Filter() {
+
+ @Override
+ public boolean filterObject(Sone sone) {
+ return sone.getTime() != 0;
+ }
+ };
+
+ /** Filter that matches all {@link Core#isLocalSone(Sone) local Sones}. */
+ public static final Filter LOCAL_SONE_FILTER = new Filter() {
+
+ @Override
+ public boolean filterObject(Sone sone) {
+ return sone.getIdentity() instanceof OwnIdentity;
+ }
+
+ };
/** 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 = new Profile();
+
+ /** The client used by the Sone. */
+ private volatile Client client;
/** All friend Sones. */
- private final Set friendSones = new HashSet();
+ private final Set friendSones = Collections.synchronizedSet(new HashSet());
/** All posts. */
- private final Set posts = new HashSet();
+ private final Set posts = Collections.synchronizedSet(new HashSet());
/** All replies. */
- private final Set replies = new HashSet();
+ private final Set replies = Collections.synchronizedSet(new HashSet());
- /** The IDs of all blocked Sones. */
- private final Set blockedSoneIds = new HashSet();
+ /** The IDs of all liked posts. */
+ private final Set likedPostIds = Collections.synchronizedSet(new HashSet());
- /** Modification count. */
- private volatile long modificationCounter = 0;
+ /** The IDs of all liked replies. */
+ private final Set likedReplyIds = Collections.synchronizedSet(new HashSet());
+
+ /** Sone-specific options. */
+ private final Options options = new Options();
/**
* 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;
}
//
@@ -93,42 +163,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 != null) ? requestUri.setSuggestedEdition(latestEdition) : null;
}
/**
@@ -139,7 +224,14 @@ public class Sone {
* @return This Sone (for method chaining)
*/
public Sone setRequestUri(FreenetURI requestUri) {
- this.requestUri = requestUri;
+ if (this.requestUri == null) {
+ this.requestUri = requestUri.setKeyType("USK").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;
+ }
return this;
}
@@ -149,7 +241,7 @@ public class Sone {
* @return The insert URI of this Sone
*/
public FreenetURI getInsertUri() {
- return insertUri;
+ return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null;
}
/**
@@ -160,11 +252,43 @@ public class Sone {
* @return This Sone (for method chaining)
*/
public Sone setInsertUri(FreenetURI insertUri) {
- this.insertUri = insertUri;
+ if (this.insertUri == null) {
+ this.insertUri = insertUri.setKeyType("USK").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;
+ }
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)
@@ -192,7 +316,7 @@ public class Sone {
*
* @return A copy of the profile
*/
- public Profile getProfile() {
+ public synchronized Profile getProfile() {
return new Profile(profile);
}
@@ -206,7 +330,27 @@ public class Sone {
*/
public synchronized void setProfile(Profile profile) {
this.profile = new Profile(profile);
- modificationCounter++;
+ }
+
+ /**
+ * Returns the client used by this Sone.
+ *
+ * @return The client used by this Sone, or {@code null}
+ */
+ public Client getClient() {
+ return client;
+ }
+
+ /**
+ * Sets the client used by this Sone.
+ *
+ * @param client
+ * The client used by this Sone, or {@code null}
+ * @return This Sone (for method chaining)
+ */
+ public Sone setClient(Client client) {
+ this.client = client;
+ return this;
}
/**
@@ -214,8 +358,9 @@ public class Sone {
*
* @return The friend Sones of this Sone
*/
- public Set getFriends() {
- return Collections.unmodifiableSet(friendSones);
+ public List getFriends() {
+ List friends = new ArrayList(friendSones);
+ return friends;
}
/**
@@ -225,23 +370,22 @@ public class Sone {
* The new (and only) friends of this Sone
* @return This Sone (for method chaining)
*/
- public synchronized Sone setFriends(Collection friends) {
+ public Sone setFriends(Collection friends) {
friendSones.clear();
friendSones.addAll(friends);
- modificationCounter++;
return this;
}
/**
* Returns whether this Sone has the given Sone as a friend Sone.
*
- * @param friendSone
- * The friend Sone to check for
+ * @param friendSoneId
+ * The ID of the Sone to check for
* @return {@code true} if this Sone has the given Sone as a friend,
* {@code false} otherwise
*/
- public boolean hasFriend(Sone friendSone) {
- return friendSones.contains(friendSone);
+ public boolean hasFriend(String friendSoneId) {
+ return friendSones.contains(friendSoneId);
}
/**
@@ -251,9 +395,9 @@ public class Sone {
* The friend Sone to add
* @return This Sone (for method chaining)
*/
- public synchronized Sone addFriend(Sone friendSone) {
- if (!friendSone.equals(this) && friendSones.add(friendSone)) {
- modificationCounter++;
+ public Sone addFriend(String friendSone) {
+ if (!friendSone.equals(id)) {
+ friendSones.add(friendSone);
}
return this;
}
@@ -261,14 +405,12 @@ public class Sone {
/**
* Removes the given Sone as a friend Sone.
*
- * @param friendSone
- * The friend Sone to remove
+ * @param friendSoneId
+ * The ID of 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(String friendSoneId) {
+ friendSones.remove(friendSoneId);
return this;
}
@@ -278,15 +420,11 @@ public class Sone {
* @return All posts of this Sone
*/
public List getPosts() {
- List sortedPosts = new ArrayList(posts);
- Collections.sort(sortedPosts, new Comparator() {
-
- @Override
- public int compare(Post leftPost, Post rightPost) {
- return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
- }
-
- });
+ List sortedPosts;
+ synchronized (this) {
+ sortedPosts = new ArrayList(posts);
+ }
+ Collections.sort(sortedPosts, Post.TIME_COMPARATOR);
return sortedPosts;
}
@@ -298,9 +436,10 @@ public class Sone {
* @return This Sone (for method chaining)
*/
public synchronized Sone setPosts(Collection posts) {
- this.posts.clear();
- this.posts.addAll(posts);
- modificationCounter++;
+ synchronized (this) {
+ this.posts.clear();
+ this.posts.addAll(posts);
+ }
return this;
}
@@ -314,7 +453,6 @@ public class Sone {
public synchronized void addPost(Post post) {
if (post.getSone().equals(this) && posts.add(post)) {
logger.log(Level.FINEST, "Adding %s to â%sâ.", new Object[] { post, getName() });
- modificationCounter++;
}
}
@@ -325,8 +463,8 @@ public class Sone {
* The post to remove
*/
public synchronized void removePost(Post post) {
- if (post.getSone().equals(this) && posts.remove(post)) {
- modificationCounter++;
+ if (post.getSone().equals(this)) {
+ posts.remove(post);
}
}
@@ -335,8 +473,7 @@ public class Sone {
*
* @return All replies this Sone made
*/
- public Set getReplies() {
- logger.log(Level.FINEST, "Friends of %s: %s", new Object[] { this, friendSones });
+ public synchronized Set getReplies() {
return Collections.unmodifiableSet(replies);
}
@@ -350,7 +487,6 @@ public class Sone {
public synchronized Sone setReplies(Collection replies) {
this.replies.clear();
this.replies.addAll(replies);
- modificationCounter++;
return this;
}
@@ -362,8 +498,8 @@ public class Sone {
* The reply to add
*/
public synchronized void addReply(Reply reply) {
- if (reply.getSone().equals(this) && replies.add(reply)) {
- modificationCounter++;
+ if (reply.getSone().equals(this)) {
+ replies.add(reply);
}
}
@@ -374,89 +510,191 @@ public class Sone {
* The reply to remove
*/
public synchronized void removeReply(Reply reply) {
- if (reply.getSone().equals(this) && replies.remove(reply)) {
- modificationCounter++;
+ if (reply.getSone().equals(this)) {
+ replies.remove(reply);
}
}
/**
- * Returns the IDs of all blocked Sones. These Sones will not propagated
- * using the âknown Sonesâ mechanism.
+ * Returns the IDs of all liked posts.
*
- * @return The IDs of all blocked Sones
+ * @return All liked postsâ IDs
*/
- public Set getBlockedSoneIds() {
- return Collections.unmodifiableSet(blockedSoneIds);
+ public Set getLikedPostIds() {
+ return Collections.unmodifiableSet(likedPostIds);
}
/**
- * Returns whether the given Sone ID is blocked.
+ * Sets the IDs of all liked posts.
*
- * @param soneId
- * The Sone ID to check
- * @return {@code true} if the given Sone ID is blocked, {@code false}
+ * @param likedPostIds
+ * All liked postsâ IDs
+ * @return This Sone (for method chaining)
+ */
+ public synchronized Sone setLikePostIds(Set likedPostIds) {
+ this.likedPostIds.clear();
+ this.likedPostIds.addAll(likedPostIds);
+ 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 isSoneBlocked(String soneId) {
- return blockedSoneIds.contains(soneId);
+ public boolean isLikedPostId(String postId) {
+ return likedPostIds.contains(postId);
}
/**
- * Adds the given ID to the list of blocked IDs.
+ * Adds the given post ID to the list of posts this Sone likes.
*
- * @param soneId
- * The Sone ID to block
+ * @param postId
+ * The ID of the post
+ * @return This Sone (for method chaining)
*/
- public synchronized void addBlockedSoneId(String soneId) {
- if (blockedSoneIds.add(soneId)) {
- modificationCounter++;
- }
+ public synchronized Sone addLikedPostId(String postId) {
+ likedPostIds.add(postId);
+ return this;
}
/**
- * Removes the given ID from the list of blocked IDs.
+ * Removes the given post ID from the list of posts this Sone likes.
*
- * @param soneId
- * The Sone ID to unblock
+ * @param postId
+ * The ID of the post
+ * @return This Sone (for method chaining)
*/
- public synchronized void removeBlockedSoneId(String soneId) {
- if (blockedSoneIds.remove(soneId)) {
- modificationCounter++;
- }
+ public synchronized Sone removeLikedPostId(String postId) {
+ likedPostIds.remove(postId);
+ return this;
}
/**
- * Returns the modification counter.
+ * Returns the IDs of all liked replies.
*
- * @return The modification counter
+ * @return All liked repliesâ IDs
*/
- public synchronized long getModificationCounter() {
- return modificationCounter;
+ public Set getLikedReplyIds() {
+ return Collections.unmodifiableSet(likedReplyIds);
}
/**
- * Sets the modification counter.
+ * Sets the IDs of all liked replies.
*
- * @param modificationCounter
- * The new modification counter
+ * @param likedReplyIds
+ * All liked repliesâ IDs
+ * @return This Sone (for method chaining)
*/
- public synchronized void setModificationCounter(long modificationCounter) {
- this.modificationCounter = modificationCounter;
+ public synchronized Sone setLikeReplyIds(Set likedReplyIds) {
+ this.likedReplyIds.clear();
+ this.likedReplyIds.addAll(likedReplyIds);
+ return this;
}
/**
- * Updates the suggested edition in both the request URI and the insert URI.
+ * Checks whether the given reply ID is liked by this Sone.
*
- * @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);
+ * @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) {
+ likedReplyIds.add(replyId);
+ 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) {
+ likedReplyIds.remove(replyId);
+ return this;
+ }
+
+ /**
+ * Returns Sone-specific options.
+ *
+ * @return The options of this Sone
+ */
+ public Options getOptions() {
+ return options;
+ }
+
+ //
+ // FINGERPRINTABLE METHODS
+ //
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public synchronized String getFingerprint() {
+ StringBuilder fingerprint = new StringBuilder();
+ fingerprint.append(profile.getFingerprint());
+
+ fingerprint.append("Posts(");
+ for (Post post : getPosts()) {
+ fingerprint.append("Post(").append(post.getId()).append(')');
}
+ fingerprint.append(")");
+
+ List replies = new ArrayList(getReplies());
+ Collections.sort(replies, Reply.TIME_COMPARATOR);
+ fingerprint.append("Replies(");
+ for (Reply reply : replies) {
+ fingerprint.append("Reply(").append(reply.getId()).append(')');
+ }
+ fingerprint.append(')');
+
+ List likedPostIds = new ArrayList(getLikedPostIds());
+ Collections.sort(likedPostIds);
+ fingerprint.append("LikedPosts(");
+ for (String likedPostId : likedPostIds) {
+ fingerprint.append("Post(").append(likedPostId).append(')');
+ }
+ fingerprint.append(')');
+
+ List likedReplyIds = new ArrayList(getLikedReplyIds());
+ Collections.sort(likedReplyIds);
+ fingerprint.append("LikedReplies(");
+ for (String likedReplyId : likedReplyIds) {
+ fingerprint.append("Reply(").append(likedReplyId).append(')');
+ }
+ fingerprint.append(')');
+
+ return fingerprint.toString();
+ }
+
+ //
+ // INTERFACE Comparable
+ //
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public int compareTo(Sone sone) {
+ return NICE_NAME_COMPARATOR.compare(this, sone);
}
//
@@ -487,7 +725,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(" + String.valueOf(insertUri).length() + "),friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
}
}