/*
- * 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 java.util.ArrayList;
+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.Collection;
import java.util.Collections;
import java.util.Comparator;
-import java.util.HashSet;
import java.util.List;
import java.util.Set;
-import java.util.logging.Level;
-import java.util.logging.Logger;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import net.pterodactylus.sone.freenet.wot.Identity;
+import net.pterodactylus.sone.freenet.wot.OwnIdentity;
import net.pterodactylus.sone.template.SoneAccessor;
-import net.pterodactylus.util.logging.Logging;
+
import freenet.keys.FreenetURI;
+import com.google.common.base.Function;
+import com.google.common.base.Predicate;
+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>
- * 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 {
+public interface Sone extends Identified, 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>() {
};
- /** The logger. */
- private static final Logger logger = Logging.getLogger(Sone.class);
-
- /** The ID of this Sone. */
- private final String id;
+ /** Comparator that sorts Sones by last activity (least recent active first). */
+ public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
- /** The identity of this Sone. */
- private Identity identity;
-
- /** The URI under which the Sone is stored in Freenet. */
- private volatile FreenetURI requestUri;
+ @Override
+ public int compare(Sone firstSone, Sone secondSone) {
+ return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
+ }
+ };
- /** The URI used to insert a new version of this Sone. */
- /* This will be null for remote Sones! */
- private volatile FreenetURI insertUri;
+ /** Comparator that sorts Sones by numbers of posts (descending). */
+ public static final Comparator<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
- /** The latest edition of the Sone. */
- private volatile long latestEdition;
+ /**
+ * {@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());
+ }
+ };
- /** The time of the last inserted update. */
- private volatile long time;
+ /** Comparator that sorts Sones by number of images (descending). */
+ public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
- /** The profile of this Sone. */
- private volatile Profile profile;
+ /**
+ * {@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);
+ }
+ };
- /** All friend Sones. */
- private final Set<String> friendSones = Collections.synchronizedSet(new HashSet<String>());
+ /** Filter to remove Sones that have not been downloaded. */
+ public static final Predicate<Sone> EMPTY_SONE_FILTER = new Predicate<Sone>() {
- /** All posts. */
- private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
+ @Override
+ public boolean apply(Sone sone) {
+ return (sone != null) && (sone.getTime() != 0);
+ }
+ };
- /** All replies. */
- private final Set<Reply> replies = Collections.synchronizedSet(new HashSet<Reply>());
+ /** Filter that matches all {@link Sone#isLocal() local Sones}. */
+ public static final Predicate<Sone> LOCAL_SONE_FILTER = new Predicate<Sone>() {
- /** The IDs of all liked posts. */
- private final Set<String> likedPostIds = Collections.synchronizedSet(new HashSet<String>());
+ @Override
+ public boolean apply(Sone sone) {
+ return (sone != null) && (sone.getIdentity() instanceof OwnIdentity);
+ }
- /** The IDs of all liked replies. */
- private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
+ };
- /** Modification count. */
- private volatile long modificationCounter = 0;
+ /** Filter that matches Sones that have at least one album. */
+ public static final Predicate<Sone> HAS_ALBUM_FILTER = new Predicate<Sone>() {
- /**
- * Creates a new Sone.
- *
- * @param id
- * The ID of the Sone
- */
- public Sone(String id) {
- this.id = id;
- }
+ @Override
+ public boolean apply(Sone sone) {
+ return (sone != null) && !sone.getRootAlbum().getAlbums().isEmpty();
+ }
+ };
- //
- // ACCESSORS
- //
+ public static final Function<Sone, String> toSoneXmlUri =
+ new Function<Sone, String>() {
+ @Nonnull
+ @Override
+ public String apply(@Nullable Sone input) {
+ return input.getRequestUri()
+ .setMetaString(new String[] { "sone.xml" })
+ .toString();
+ }
+ };
+
+ public static final Function<Sone, List<Album>> toAllAlbums = new Function<Sone, List<Album>>() {
+ @Override
+ public List<Album> apply(@Nullable Sone sone) {
+ return (sone == null) ? Collections.<Album>emptyList() : FLATTENER.apply(
+ sone.getRootAlbum());
+ }
+ };
- /**
- * Returns the identity of this Sone.
- *
- * @return The identity of this Sone
- */
- public String getId() {
- return id;
- }
+ public static final Function<Sone, List<Image>> toAllImages = new Function<Sone, List<Image>>() {
+ @Override
+ public List<Image> apply(@Nullable Sone sone) {
+ return (sone == null) ? Collections.<Image>emptyList() :
+ from(FLATTENER.apply(sone.getRootAlbum()))
+ .transformAndConcat(IMAGES).toList();
+ }
+ };
/**
* 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;
- }
+ Identity getIdentity();
/**
* Returns the name of this Sone.
*
* @return The name of this Sone
*/
- public String getName() {
- return (identity != null) ? identity.getNickname() : null;
- }
+ String getName();
/**
- * Returns the request URI of this Sone.
+ * Returns whether this Sone is a local Sone.
*
- * @return The request URI of this Sone
+ * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
*/
- public FreenetURI getRequestUri() {
- return (requestUri != null) ? requestUri.setSuggestedEdition(latestEdition) : null;
- }
+ boolean isLocal();
/**
- * Sets the request URI of this Sone.
+ * Returns the request URI of this Sone.
*
- * @param requestUri
- * The request URI of this Sone
- * @return This Sone (for method chaining)
+ * @return The request URI of this Sone
*/
- 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;
- }
- return this;
- }
+ FreenetURI getRequestUri();
/**
* Returns the insert URI of this Sone.
*
* @return The insert URI of this Sone
*/
- public FreenetURI getInsertUri() {
- return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null;
- }
-
- /**
- * 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;
- }
- return this;
- }
+ FreenetURI getInsertUri();
/**
* Returns the latest edition of this Sone.
*
* @return The latest edition of this Sone
*/
- public long getLatestEdition() {
- return latestEdition;
- }
+ long getLatestEdition();
/**
* 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 });
- return;
- }
- this.latestEdition = latestEdition;
- }
+ void setLatestEdition(long 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;
- }
+ long getTime();
/**
- * Sets the time of the last inserted update of this Sone.
+ * Returns the status of this Sone.
*
- * @param time
- * The time of the update (in milliseconds since Jan 1, 1970 UTC)
- * @return This Sone (for method chaining)
+ * @return The status of this Sone
*/
- public Sone setTime(long time) {
- this.time = time;
- return this;
- }
+ SoneStatus getStatus();
+
+ /**
+ * 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}
+ */
+ Sone setStatus(SoneStatus status);
/**
- * 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 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 Profile getProfile() {
- return new Profile(profile);
- }
+ Profile getProfile();
/**
- * 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) {
- this.profile = new Profile(profile);
- modificationCounter++;
- }
+ void setProfile(Profile profile);
/**
- * Returns all friend Sones of this Sone.
+ * Returns the client used by this Sone.
*
- * @return The friend Sones of this Sone
+ * @return The client used by this Sone, or {@code null}
*/
- public List<String> getFriends() {
- List<String> friends = new ArrayList<String>(friendSones);
- return friends;
- }
+ Client getClient();
/**
- * Sets all friends of this Sone at once.
+ * Returns whether this Sone is known.
*
- * @param friends
- * The new (and only) friends of this Sone
- * @return This Sone (for method chaining)
+ * @return {@code true} if this Sone is known, {@code false} otherwise
*/
- public Sone setFriends(Collection<String> friends) {
- friendSones.clear();
- friendSones.addAll(friends);
- return this;
- }
+ boolean isKnown();
/**
- * Returns whether this Sone has the given Sone as a friend Sone.
+ * Sets whether this Sone is known.
*
- * @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
+ * @param known
+ * {@code true} if this Sone is known, {@code false} otherwise
+ * @return This Sone
*/
- public boolean hasFriend(String friendSoneId) {
- return friendSones.contains(friendSoneId);
- }
+ Sone setKnown(boolean known);
/**
- * Adds the given Sone as a friend Sone.
+ * Returns all friend Sones of this Sone.
*
- * @param friendSone
- * The friend Sone to add
- * @return This Sone (for method chaining)
+ * @return The friend Sones of this Sone
*/
- public Sone addFriend(String friendSone) {
- if (!friendSone.equals(id)) {
- friendSones.add(friendSone);
- }
- return this;
- }
+ Collection<String> getFriends();
/**
- * Removes the given Sone as a friend Sone.
+ * Returns whether this Sone has the given Sone as a friend Sone.
*
* @param friendSoneId
- * The ID of the friend Sone to remove
- * @return This Sone (for method chaining)
+ * 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 Sone removeFriend(String friendSoneId) {
- friendSones.remove(friendSoneId);
- return this;
- }
+ boolean hasFriend(String friendSoneId);
/**
* Returns the list of posts of this Sone, sorted by time, newest first.
*
* @return All posts of this Sone
*/
- public List<Post> getPosts() {
- List<Post> sortedPosts;
- synchronized (this) {
- sortedPosts = new ArrayList<Post>(posts);
- }
- Collections.sort(sortedPosts, Post.TIME_COMPARATOR);
- return sortedPosts;
- }
-
- /**
- * 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.
- *
- * @param post
- * The post to add
- */
- 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++;
- }
- }
-
- /**
- * Removes the given post from this Sone.
- *
- * @param post
- * The post to remove
- */
- public synchronized void removePost(Post post) {
- if (post.getSone().equals(this) && posts.remove(post)) {
- modificationCounter++;
- }
- }
+ List<Post> getPosts();
/**
* Returns all replies this Sone made.
*
* @return All replies this Sone made
*/
- public synchronized Set<Reply> getReplies() {
- return Collections.unmodifiableSet(replies);
- }
+ Set<PostReply> getReplies();
/**
* 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) {
- this.replies.clear();
- this.replies.addAll(replies);
- modificationCounter++;
- return this;
- }
+ Sone setReplies(Collection<PostReply> replies);
/**
* Adds a reply to this Sone. If the given reply was not made by this Sone,
* nothing is added to this Sone.
*
* @param reply
- * The reply to add
+ * The reply to add
*/
- public synchronized void addReply(Reply reply) {
- if (reply.getSone().equals(this) && replies.add(reply)) {
- modificationCounter++;
- }
- }
+ void addReply(PostReply reply);
/**
* Removes a reply from this Sone.
*
* @param reply
- * The reply to remove
+ * The reply to remove
*/
- public synchronized void removeReply(Reply reply) {
- if (reply.getSone().equals(this) && replies.remove(reply)) {
- modificationCounter++;
- }
- }
+ void removeReply(PostReply reply);
/**
* Returns the IDs of all liked posts.
*
* @return All liked posts’ IDs
*/
- public Set<String> getLikedPostIds() {
- return Collections.unmodifiableSet(likedPostIds);
- }
+ Set<String> getLikedPostIds();
/**
* 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) {
- this.likedPostIds.clear();
- this.likedPostIds.addAll(likedPostIds);
- modificationCounter++;
- return this;
- }
+ Sone setLikePostIds(Set<String> likedPostIds);
/**
* 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
*/
- public boolean isLikedPostId(String postId) {
- return likedPostIds.contains(postId);
- }
+ boolean isLikedPostId(String postId);
/**
* 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) {
- if (likedPostIds.add(postId)) {
- modificationCounter++;
- }
- return this;
- }
+ Sone addLikedPostId(String postId);
/**
* 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) {
- if (likedPostIds.remove(postId)) {
- modificationCounter++;
- }
- return this;
- }
+ Sone removeLikedPostId(String postId);
/**
* Returns the IDs of all liked replies.
*
* @return All liked replies’ IDs
*/
- public Set<String> getLikedReplyIds() {
- return Collections.unmodifiableSet(likedReplyIds);
- }
+ Set<String> getLikedReplyIds();
/**
* 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) {
- this.likedReplyIds.clear();
- this.likedReplyIds.addAll(likedReplyIds);
- modificationCounter++;
- return this;
- }
+ Sone setLikeReplyIds(Set<String> likedReplyIds);
/**
* 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
*/
- public boolean isLikedReplyId(String replyId) {
- return likedReplyIds.contains(replyId);
- }
+ boolean isLikedReplyId(String replyId);
/**
* 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) {
- if (likedReplyIds.add(replyId)) {
- modificationCounter++;
- }
- return this;
- }
+ Sone addLikedReplyId(String replyId);
/**
* 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) {
- if (likedReplyIds.remove(replyId)) {
- modificationCounter++;
- }
- return this;
- }
+ Sone removeLikedReplyId(String replyId);
/**
- * Returns the modification counter.
+ * Returns the root album that contains all visible albums of this Sone.
*
- * @return The modification counter
+ * @return The root album of this Sone
*/
- public synchronized long getModificationCounter() {
- return modificationCounter;
- }
+ Album getRootAlbum();
/**
- * Sets the modification counter.
+ * Returns Sone-specific options.
*
- * @param modificationCounter
- * The new modification counter
+ * @return The options of this Sone
*/
- public synchronized void setModificationCounter(long modificationCounter) {
- this.modificationCounter = modificationCounter;
- }
-
- //
- // OBJECT METHODS
- //
+ SoneOptions getOptions();
/**
- * {@inheritDoc}
- */
- @Override
- public int hashCode() {
- return id.hashCode();
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- public boolean equals(Object object) {
- if (!(object instanceof Sone)) {
- return false;
- }
- return ((Sone) object).id.equals(id);
- }
-
- /**
- * {@inheritDoc}
+ * Sets the options of this Sone.
+ *
+ * @param options
+ * The options of this Sone
*/
- @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() + ")]";
- }
+ /* TODO - remove this method again, maybe add an option provider */
+ void setOptions(SoneOptions options);
}