/*
- * FreenetSone - Sone.java - Copyright © 2010 David Roden
+ * Sone - Sone.java - Copyright © 2010–2013 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
package net.pterodactylus.sone.data;
+import static com.google.common.base.Preconditions.*;
+import static com.google.common.collect.FluentIterable.from;
+import static java.util.Arrays.asList;
+import static net.pterodactylus.sone.data.Album.FLATTENER;
+import static net.pterodactylus.sone.data.Album.IMAGES;
+
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.concurrent.CopyOnWriteArraySet;
import java.util.logging.Level;
import java.util.logging.Logger;
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;
+import com.google.common.base.Predicate;
+import com.google.common.hash.Hasher;
+import com.google.common.hash.Hashing;
+import com.google.common.primitives.Ints;
+
/**
* A Sone defines everything about a user: her profile, her status updates, her
* replies, her likes and dislikes, etc.
- * <p>
+ * <p/>
* Operations that modify the Sone need to synchronize on the Sone in question.
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class Sone implements Fingerprintable, Comparable<Sone> {
+ /**
+ * Enumeration for the possible states of a {@link Sone}.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+ public enum SoneStatus {
+
+ /** The Sone is unknown, i.e. not yet downloaded. */
+ unknown,
+
+ /** The Sone is idle, i.e. not being downloaded or inserted. */
+ idle,
+
+ /** The Sone is currently being inserted. */
+ inserting,
+
+ /** The Sone is currently being downloaded. */
+ downloading,
+ }
+
+ /**
+ * The possible values for the “show custom avatars” option.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+ public static enum ShowCustomAvatars {
+
+ /** Never show custom avatars. */
+ NEVER,
+
+ /** Only show custom avatars of followed Sones. */
+ FOLLOWED,
+
+ /** Only show custom avatars of Sones you manually trust. */
+ MANUALLY_TRUSTED,
+
+ /** Only show custom avatars of automatically trusted Sones. */
+ TRUSTED,
+
+ /** Always show custom avatars. */
+ ALWAYS,
+
+ }
+
/** comparator that sorts Sones by their nice name. */
public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
};
+ /** Comparator that sorts Sones by last activity (least recent active first). */
+ public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
+
+ @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<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
+
+ /**
+ * {@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());
+ }
+ };
+
+ /** Comparator that sorts Sones by number of images (descending). */
+ public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public int compare(Sone leftSone, Sone rightSone) {
+ int rightSoneImageCount = from(asList(rightSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
+ int leftSoneImageCount = from(asList(leftSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
+ /* sort descending. */
+ return Ints.compare(rightSoneImageCount, leftSoneImageCount);
+ }
+ };
+
/** Filter to remove Sones that have not been downloaded. */
- public static final Filter<Sone> EMPTY_SONE_FILTER = new Filter<Sone>() {
+ public static final Predicate<Sone> EMPTY_SONE_FILTER = new Predicate<Sone>() {
@Override
- public boolean filterObject(Sone sone) {
+ public boolean apply(Sone sone) {
return sone.getTime() != 0;
}
};
+ /** Filter that matches all {@link Sone#isLocal() local Sones}. */
+ public static final Predicate<Sone> LOCAL_SONE_FILTER = new Predicate<Sone>() {
+
+ @Override
+ public boolean apply(Sone sone) {
+ return sone.getIdentity() instanceof OwnIdentity;
+ }
+
+ };
+
+ /** Filter that matches Sones that have at least one album. */
+ public static final Predicate<Sone> HAS_ALBUM_FILTER = new Predicate<Sone>() {
+
+ @Override
+ public boolean apply(Sone sone) {
+ return !sone.getRootAlbum().getAlbums().isEmpty();
+ }
+ };
+
/** The logger. */
private static final Logger logger = Logging.getLogger(Sone.class);
/** The ID of this Sone. */
private final String id;
+ /** Whether the Sone is local. */
+ private final boolean local;
+
/** The identity of this Sone. */
private Identity identity;
/** The time of the last inserted update. */
private volatile long time;
+ /** The status of this Sone. */
+ private volatile SoneStatus status = SoneStatus.unknown;
+
/** The profile of this Sone. */
- private volatile Profile profile = new Profile();
+ private volatile Profile profile = new Profile(this);
/** The client used by the Sone. */
private volatile Client client;
+ /** Whether this Sone is known. */
+ private volatile boolean known;
+
/** All friend Sones. */
- private final Set<String> friendSones = Collections.synchronizedSet(new HashSet<String>());
+ private final Set<String> friendSones = new CopyOnWriteArraySet<String>();
/** All posts. */
- private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
+ private final Set<Post> posts = new CopyOnWriteArraySet<Post>();
/** All replies. */
- private final Set<Reply> replies = Collections.synchronizedSet(new HashSet<Reply>());
+ private final Set<PostReply> replies = new CopyOnWriteArraySet<PostReply>();
/** The IDs of all liked posts. */
- private final Set<String> likedPostIds = Collections.synchronizedSet(new HashSet<String>());
+ private final Set<String> likedPostIds = new CopyOnWriteArraySet<String>();
/** The IDs of all liked replies. */
- private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
+ private final Set<String> likedReplyIds = new CopyOnWriteArraySet<String>();
+
+ /** The root album containing all albums. */
+ private final Album rootAlbum = new Album().setSone(this);
/** Sone-specific options. */
- private final Options options = new Options();
+ private Options options = new Options();
/**
* Creates a new Sone.
*
* @param id
- * The ID of the Sone
+ * The ID of the Sone
+ * @param local
+ * {@code true} if the Sone is a local Sone, {@code false} otherwise
*/
- public Sone(String id) {
+ public Sone(String id, boolean local) {
this.id = id;
+ this.local = local;
}
//
* identity has to match this Sone’s {@link #getId()}.
*
* @param identity
- * The identity of this Sone
+ * 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
+ * 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)) {
}
/**
+ * Returns whether this Sone is a local Sone.
+ *
+ * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
+ */
+ public boolean isLocal() {
+ return local;
+ }
+
+ /**
* Returns the request URI of this Sone.
*
* @return The request URI of this Sone
* Sets the request URI of this Sone.
*
* @param requestUri
- * The request URI of this Sone
+ * The request URI of this Sone
* @return This Sone (for method chaining)
*/
public Sone setRequestUri(FreenetURI requestUri) {
return this;
}
if (!this.requestUri.equalsKeypair(requestUri)) {
- logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { requestUri, this.requestUri });
+ logger.log(Level.WARNING, String.format("Request URI %s tried to overwrite %s!", requestUri, this.requestUri));
return this;
}
return this;
* Sets the insert URI of this Sone.
*
* @param insertUri
- * The insert URI of this Sone
+ * The insert URI of this Sone
* @return This Sone (for method chaining)
*/
public Sone setInsertUri(FreenetURI insertUri) {
return this;
}
if (!this.insertUri.equalsKeypair(insertUri)) {
- logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { insertUri, this.insertUri });
+ logger.log(Level.WARNING, String.format("Request URI %s tried to overwrite %s!", insertUri, this.insertUri));
return this;
}
return this;
/**
* 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.
+ * greater than the current latest edition, the latest edition of this Sone is
+ * not changed.
*
* @param latestEdition
- * The latest edition of this Sone
+ * 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 });
+ logger.log(Level.FINE, String.format("New latest edition %d is not greater than current latest edition %d!", latestEdition, this.latestEdition));
return;
}
this.latestEdition = latestEdition;
* 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)
+ * The time of the update (in milliseconds since Jan 1, 1970 UTC)
* @return This Sone (for method chaining)
*/
public Sone setTime(long time) {
}
/**
- * Returns a copy of the profile. If you want to update values in the
- * profile of this Sone, update the values in the returned {@link Profile}
- * and use {@link #setProfile(Profile)} to change the profile in this Sone.
+ * Returns the status of this Sone.
+ *
+ * @return The status of this Sone
+ */
+ public SoneStatus getStatus() {
+ return status;
+ }
+
+ /**
+ * Sets the new status of this Sone.
+ *
+ * @param status
+ * The new status of this Sone
+ * @return This Sone
+ * @throws IllegalArgumentException
+ * if {@code status} is {@code null}
+ */
+ public Sone setStatus(SoneStatus status) {
+ this.status = checkNotNull(status, "status must not be null");
+ return this;
+ }
+
+ /**
+ * Returns a copy of the profile. If you want to update values in the profile
+ * of this Sone, update the values in the returned {@link Profile} and use
+ * {@link #setProfile(Profile)} to change the profile in this Sone.
*
* @return A copy of the profile
*/
- public synchronized Profile getProfile() {
+ public Profile getProfile() {
return new Profile(profile);
}
/**
- * Sets the profile of this Sone. A copy of the given profile is stored so
- * that subsequent modifications of the given profile are not reflected in
- * this Sone!
+ * Sets the profile of this Sone. A copy of the given profile is stored so that
+ * subsequent modifications of the given profile are not reflected in this
+ * Sone!
*
* @param profile
- * The profile to set
+ * The profile to set
*/
- public synchronized void setProfile(Profile profile) {
+ public void setProfile(Profile profile) {
this.profile = new Profile(profile);
}
* Sets the client used by this Sone.
*
* @param client
- * The client used by this Sone, or {@code null}
+ * The client used by this Sone, or {@code null}
* @return This Sone (for method chaining)
*/
public Sone setClient(Client client) {
}
/**
- * Returns all friend Sones of this Sone.
+ * Returns whether this Sone is known.
*
- * @return The friend Sones of this Sone
+ * @return {@code true} if this Sone is known, {@code false} otherwise
*/
- public List<String> getFriends() {
- List<String> friends = new ArrayList<String>(friendSones);
- return friends;
+ public boolean isKnown() {
+ return known;
}
/**
- * Sets all friends of this Sone at once.
+ * Sets whether this Sone is known.
*
- * @param friends
- * The new (and only) friends of this Sone
- * @return This Sone (for method chaining)
+ * @param known
+ * {@code true} if this Sone is known, {@code false} otherwise
+ * @return This Sone
*/
- public Sone setFriends(Collection<String> friends) {
- friendSones.clear();
- friendSones.addAll(friends);
+ public Sone setKnown(boolean known) {
+ this.known = known;
return this;
}
/**
+ * Returns all friend Sones of this Sone.
+ *
+ * @return The friend Sones of this Sone
+ */
+ public List<String> getFriends() {
+ List<String> friends = new ArrayList<String>(friendSones);
+ return friends;
+ }
+
+ /**
* Returns whether this Sone has the given Sone as a friend Sone.
*
* @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
+ * 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(String friendSoneId) {
return friendSones.contains(friendSoneId);
* Adds the given Sone as a friend Sone.
*
* @param friendSone
- * The friend Sone to add
+ * The friend Sone to add
* @return This Sone (for method chaining)
*/
public Sone addFriend(String friendSone) {
* Removes the given Sone as a friend Sone.
*
* @param friendSoneId
- * The ID of the friend Sone to remove
+ * The ID of the friend Sone to remove
* @return This Sone (for method chaining)
*/
public Sone removeFriend(String friendSoneId) {
* Sets all posts of this Sone at once.
*
* @param posts
- * The new (and only) posts of this Sone
+ * The new (and only) posts of this Sone
* @return This Sone (for method chaining)
*/
- public
synchronized Sone setPosts(Collection<Post> posts) {
+ public Sone setPosts(Collection<Post> posts) {
synchronized (this) {
this.posts.clear();
this.posts.addAll(posts);
}
/**
- * Adds the given post to this Sone. The post will not be added if its
- * {@link Post#getSone() Sone} is not this Sone.
+ * Adds the given post to this Sone. The post will not be added if its {@link
+ * Post#getSone() Sone} is not this Sone.
*
* @param post
- * The post to add
+ * The post to add
*/
- public synchronized void addPost(Post post) {
+ public void addPost(Post post) {
if (post.getSone().equals(this) && posts.add(post)) {
- logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() });
+ logger.log(Level.FINEST, String.format("Adding %s to “%s”.", post, getName()));
}
}
* Removes the given post from this Sone.
*
* @param post
- * The post to remove
+ * The post to remove
*/
- public synchronized void removePost(Post post) {
+ public void removePost(Post post) {
if (post.getSone().equals(this)) {
posts.remove(post);
}
*
* @return All replies this Sone made
*/
- public synchronized Set<Reply> getReplies() {
+ public Set<PostReply> getReplies() {
return Collections.unmodifiableSet(replies);
}
* Sets all replies of this Sone at once.
*
* @param replies
- * The new (and only) replies of this Sone
+ * The new (and only) replies of this Sone
* @return This Sone (for method chaining)
*/
- public synchronized Sone setReplies(Collection<Reply> replies) {
+ public Sone setReplies(Collection<PostReply> replies) {
this.replies.clear();
this.replies.addAll(replies);
return this;
* nothing is added to this Sone.
*
* @param reply
- * The reply to add
+ * The reply to add
*/
- public synchronized void addReply(Reply reply) {
+ public void addReply(PostReply reply) {
if (reply.getSone().equals(this)) {
replies.add(reply);
}
* Removes a reply from this Sone.
*
* @param reply
- * The reply to remove
+ * The reply to remove
*/
- public synchronized void removeReply(Reply reply) {
+ public void removeReply(PostReply reply) {
if (reply.getSone().equals(this)) {
replies.remove(reply);
}
* Sets the IDs of all liked posts.
*
* @param likedPostIds
- * All liked posts’ IDs
+ * All liked posts’ IDs
* @return This Sone (for method chaining)
*/
- public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
+ public Sone setLikePostIds(Set<String> 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
+ * The ID of the post
* @return {@code true} if this Sone likes the given post, {@code false}
* otherwise
*/
* Adds the given post ID to the list of posts this Sone likes.
*
* @param postId
- * The ID of the post
+ * The ID of the post
* @return This Sone (for method chaining)
*/
- public synchronized Sone addLikedPostId(String postId) {
+ public Sone addLikedPostId(String postId) {
likedPostIds.add(postId);
return this;
}
* Removes the given post ID from the list of posts this Sone likes.
*
* @param postId
- * The ID of the post
+ * The ID of the post
* @return This Sone (for method chaining)
*/
- public synchronized Sone removeLikedPostId(String postId) {
+ public Sone removeLikedPostId(String postId) {
likedPostIds.remove(postId);
return this;
}
* Sets the IDs of all liked replies.
*
* @param likedReplyIds
- * All liked replies’ IDs
+ * All liked replies’ IDs
* @return This Sone (for method chaining)
*/
- public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
+ public Sone setLikeReplyIds(Set<String> likedReplyIds) {
this.likedReplyIds.clear();
this.likedReplyIds.addAll(likedReplyIds);
return this;
* Checks whether the given reply ID is liked by this Sone.
*
* @param replyId
- * The ID of the reply
+ * The ID of the reply
* @return {@code true} if this Sone likes the given reply, {@code false}
* otherwise
*/
* Adds the given reply ID to the list of replies this Sone likes.
*
* @param replyId
- * The ID of the reply
+ * The ID of the reply
* @return This Sone (for method chaining)
*/
- public synchronized Sone addLikedReplyId(String replyId) {
+ public 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
+ * The ID of the reply
* @return This Sone (for method chaining)
*/
- public synchronized Sone removeLikedReplyId(String replyId) {
+ public Sone removeLikedReplyId(String replyId) {
likedReplyIds.remove(replyId);
return this;
}
/**
+ * Returns the root album that contains all visible albums of this Sone.
+ *
+ * @return The root album of this Sone
+ */
+ public Album getRootAlbum() {
+ return rootAlbum;
+ }
+
+ /**
* Returns Sone-specific options.
*
* @return The options of this Sone
return options;
}
+ /**
+ * Sets the options of this Sone.
+ *
+ * @param options
+ * The options of this Sone
+ */
+ /* TODO - remove this method again, maybe add an option provider */
+ public void setOptions(Options options) {
+ this.options = options;
+ }
+
//
// FINGERPRINTABLE METHODS
//
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public synchronized String getFingerprint() {
- StringBuilder fingerprint = new StringBuilder();
- fingerprint.append(profile.getFingerprint());
+ Hasher hash = Hashing.sha256().newHasher();
+ hash.putString(profile.getFingerprint());
- fingerprint.append("Posts(");
+ hash.putString("Posts(");
for (Post post : getPosts()) {
- fingerprint.append("Post(").append(post.getId()).append(')');
+ hash.putString("Post(").putString(post.getId()).putString(")");
}
- fingerprint.append(")");
+ hash.putString(")");
- List<Reply> replies = new ArrayList<Reply>(getReplies());
+ List<PostReply> replies = new ArrayList<PostReply>(getReplies());
Collections.sort(replies, Reply.TIME_COMPARATOR);
- fingerprint.append("Replies(");
- for (Reply reply : replies) {
- fingerprint.append("Reply(").append(reply.getId()).append(')');
+ hash.putString("Replies(");
+ for (PostReply reply : replies) {
+ hash.putString("Reply(").putString(reply.getId()).putString(")");
}
- fingerprint.append(')');
+ hash.putString(")");
List<String> likedPostIds = new ArrayList<String>(getLikedPostIds());
Collections.sort(likedPostIds);
- fingerprint.append("LikedPosts(");
+ hash.putString("LikedPosts(");
for (String likedPostId : likedPostIds) {
- fingerprint.append("Post(").append(likedPostId).append(')');
+ hash.putString("Post(").putString(likedPostId).putString(")");
}
- fingerprint.append(')');
+ hash.putString(")");
List<String> likedReplyIds = new ArrayList<String>(getLikedReplyIds());
Collections.sort(likedReplyIds);
- fingerprint.append("LikedReplies(");
+ hash.putString("LikedReplies(");
for (String likedReplyId : likedReplyIds) {
- fingerprint.append("Reply(").append(likedReplyId).append(')');
+ hash.putString("Reply(").putString(likedReplyId).putString(")");
}
- fingerprint.append(')');
+ hash.putString(")");
- return fingerprint.toString();
+ hash.putString("Albums(");
+ for (Album album : albums) {
+ hash.putString(album.getFingerprint());
+ }
+ hash.putString(")");
+
+ return hash.hash().toString();
}
//
// INTERFACE Comparable<Sone>
//
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int compareTo(Sone sone) {
return NICE_NAME_COMPARATOR.compare(this, sone);
// OBJECT METHODS
//
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public int hashCode() {
return id.hashCode();
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public boolean equals(Object object) {
if (!(object instanceof Sone)) {
return ((Sone) object).id.equals(id);
}
- /**
- * {@inheritDoc}
- */
+ /** {@inheritDoc} */
@Override
public String toString() {
return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri(" + String.valueOf(insertUri).length() + "),friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
projects / Sone.git / blobdiff