/*
- * Sone - Sone.java - Copyright © 2010 David Roden
+ * Sone - Sone.java - Copyright © 2010–2012 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 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 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 net.pterodactylus.util.validation.Validation;
+import net.pterodactylus.util.collection.filter.Filter;
import freenet.keys.FreenetURI;
/**
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
-public class Sone implements Fingerprintable, Comparable<Sone> {
+public interface Sone extends 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 number of images (descending). */
+ public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public int compare(Sone leftSone, Sone rightSone) {
+ return rightSone.getAllImages().size() - leftSone.getAllImages().size();
+ }
+ };
+
/** Filter to remove Sones that have not been downloaded. */
public static final Filter<Sone> EMPTY_SONE_FILTER = new Filter<Sone>() {
}
};
- /** Filter that matches all {@link Core#isLocalSone(Sone) local Sones}. */
+ /** Filter that matches all {@link Core#getLocalSones() local Sones}. */
public static final Filter<Sone> LOCAL_SONE_FILTER = new Filter<Sone>() {
@Override
};
- /** The logger. */
- private static final Logger logger = Logging.getLogger(Sone.class);
-
- /** The ID of this Sone. */
- private final String id;
-
- /** The identity of this Sone. */
- private Identity identity;
-
- /** The URI under which the Sone is stored in Freenet. */
- private volatile FreenetURI requestUri;
-
- /** The URI used to insert a new version of this Sone. */
- /* This will be null for remote Sones! */
- 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 volatile Profile profile = new Profile();
+ /** Filter that matches Sones that have at least one album. */
+ public static final Filter<Sone> HAS_ALBUM_FILTER = new Filter<Sone>() {
- /** The client used by the Sone. */
- private volatile Client client;
-
- /** All friend Sones. */
- private final Set<String> friendSones = Collections.synchronizedSet(new HashSet<String>());
-
- /** All posts. */
- private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
-
- /** All replies. */
- 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>());
-
- /** The albums of this Sone. */
- private final List<Album> albums = Collections.synchronizedList(new ArrayList<Album>());
-
- /** Sone-specific options. */
- private final Options options = new Options();
-
- /**
- * Creates a new Sone.
- *
- * @param id
- * The ID of the Sone
- */
- public Sone(String id) {
- this.id = id;
- }
+ @Override
+ public boolean filterObject(Sone sone) {
+ return !sone.getAlbums().isEmpty();
+ }
+ };
//
// ACCESSORS
*
* @return The identity of this Sone
*/
- public String getId() {
- return id;
- }
+ public String getId();
/**
* Returns the identity of this Sone.
*
* @return The identity of this Sone
*/
- public Identity getIdentity() {
- return identity;
- }
+ public Identity getIdentity();
/**
* Sets the identity of this Sone. The {@link Identity#getId() ID} of the
* @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;
- }
+ public Sone setIdentity(Identity identity) throws IllegalArgumentException;
+
+ /**
+ * Returns whether this Sone is local.
+ *
+ * @return {@code true} if this Sone is local, {@code false} otherwise
+ */
+ public boolean isLocal();
/**
* Returns the name of this Sone.
*
* @return The name of this Sone
*/
- public String getName() {
- return (identity != null) ? identity.getNickname() : null;
- }
+ public String getName();
/**
* Returns the request URI of this Sone.
*
* @return The request URI of this Sone
*/
- public FreenetURI getRequestUri() {
- return (requestUri != null) ? requestUri.setSuggestedEdition(latestEdition) : null;
- }
+ public FreenetURI getRequestUri();
/**
* Sets the request URI of this Sone.
* The request URI of this Sone
* @return This Sone (for method chaining)
*/
- public Sone setRequestUri(FreenetURI 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;
- }
+ public Sone setRequestUri(FreenetURI requestUri);
/**
* Returns the insert URI of this Sone.
*
* @return The insert URI of this Sone
*/
- public FreenetURI getInsertUri() {
- return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null;
- }
+ public FreenetURI getInsertUri();
/**
* Sets the insert URI of this Sone.
* The insert URI of this Sone
* @return This Sone (for method chaining)
*/
- public Sone setInsertUri(FreenetURI 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;
- }
+ public Sone setInsertUri(FreenetURI insertUri);
/**
* Returns the latest edition of this Sone.
*
* @return The latest edition of this Sone
*/
- public long getLatestEdition() {
- return latestEdition;
- }
+ public long getLatestEdition();
/**
* Sets the latest edition of this Sone. If the given latest edition is not
* @param latestEdition
* The latest edition of this Sone
*/
- public void setLatestEdition(long latestEdition) {
- if (!(latestEdition > this.latestEdition)) {
- logger.log(Level.FINE, "New latest edition %d is not greater than current latest edition %d!", new Object[] { latestEdition, this.latestEdition });
- return;
- }
- this.latestEdition = latestEdition;
- }
+ public 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;
- }
+ public long getTime();
/**
* Sets the time of the last inserted update of this Sone.
* 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;
- }
+ public Sone setTime(long time);
+
+ /**
+ * Returns the status of this Sone.
+ *
+ * @return The status of this Sone
+ */
+ public 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}
+ */
+ public Sone setStatus(SoneStatus status);
/**
* Returns a copy of the profile. If you want to update values in the
*
* @return A copy of the profile
*/
- public synchronized Profile getProfile() {
- return new Profile(profile);
- }
+ public Profile getProfile();
/**
* Sets the profile of this Sone. A copy of the given profile is stored so
* @param profile
* The profile to set
*/
- public synchronized void setProfile(Profile profile) {
- this.profile = new Profile(profile);
- }
+ public void setProfile(Profile profile);
/**
* Returns the client used by this Sone.
*
* @return The client used by this Sone, or {@code null}
*/
- public Client getClient() {
- return client;
- }
+ public Client getClient();
/**
* Sets the client used by this Sone.
* 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;
- }
+ 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();
/**
- * 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);
- return this;
- }
+ public Sone setKnown(boolean known);
+
+ /**
+ * Returns all friend Sones of this Sone.
+ *
+ * @return The friend Sones of this Sone
+ */
+ public Collection<String> getFriends();
/**
* Returns whether this Sone has the given Sone as a friend Sone.
* @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);
- }
+ public boolean hasFriend(String friendSoneId);
/**
* Adds the given Sone as a friend Sone.
* The friend Sone to add
* @return This Sone (for method chaining)
*/
- public Sone addFriend(String friendSone) {
- if (!friendSone.equals(id)) {
- friendSones.add(friendSone);
- }
- return this;
- }
+ public Sone addFriend(String friendSone);
/**
* Removes the given Sone as a friend Sone.
* The ID of the friend Sone to remove
* @return This Sone (for method chaining)
*/
- public Sone removeFriend(String friendSoneId) {
- friendSones.remove(friendSoneId);
- return this;
- }
+ public Sone removeFriend(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;
- }
+ public List<Post> getPosts();
/**
* Sets all posts of this Sone at once.
* The new (and only) posts of this Sone
* @return This Sone (for method chaining)
*/
- public synchronized Sone setPosts(Collection<Post> posts) {
- synchronized (this) {
- this.posts.clear();
- this.posts.addAll(posts);
- }
- return this;
- }
+ public Sone setPosts(Collection<Post> posts);
/**
* Adds the given post to this Sone. The post will not be added if its
* @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() });
- }
- }
+ public void addPost(Post post);
/**
* 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);
- }
- }
+ public void removePost(Post post);
/**
* Returns all replies this Sone made.
*
* @return All replies this Sone made
*/
- public synchronized Set<Reply> getReplies() {
- return Collections.unmodifiableSet(replies);
- }
+ public Set<PostReply> getReplies();
/**
* Sets all replies of this Sone at once.
* 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);
- return this;
- }
+ public Sone setReplies(Collection<PostReply> replies);
/**
* Adds a reply to this Sone. If the given reply was not made by this Sone,
* @param reply
* The reply to add
*/
- public synchronized void addReply(Reply reply) {
- if (reply.getSone().equals(this)) {
- replies.add(reply);
- }
- }
+ public void addReply(PostReply reply);
/**
* Removes a reply from this Sone.
* @param reply
* The reply to remove
*/
- public synchronized void removeReply(Reply reply) {
- if (reply.getSone().equals(this)) {
- replies.remove(reply);
- }
- }
+ public void removeReply(PostReply reply);
/**
* Returns the IDs of all liked posts.
*
* @return All liked posts’ IDs
*/
- public Set<String> getLikedPostIds() {
- return Collections.unmodifiableSet(likedPostIds);
- }
+ public Set<String> getLikedPostIds();
/**
* Sets the IDs of all liked posts.
* All liked posts’ IDs
* @return This Sone (for method chaining)
*/
- public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
- this.likedPostIds.clear();
- this.likedPostIds.addAll(likedPostIds);
- return this;
- }
+ public Sone setLikePostIds(Set<String> likedPostIds);
/**
* Checks whether the given post ID is liked by this Sone.
* @return {@code true} if this Sone likes the given post, {@code false}
* otherwise
*/
- public boolean isLikedPostId(String postId) {
- return likedPostIds.contains(postId);
- }
+ public boolean isLikedPostId(String postId);
/**
* Adds the given post ID to the list of posts this Sone likes.
* The ID of the post
* @return This Sone (for method chaining)
*/
- public synchronized Sone addLikedPostId(String postId) {
- likedPostIds.add(postId);
- return this;
- }
+ public Sone addLikedPostId(String postId);
/**
* Removes the given post ID from the list of posts this Sone likes.
* The ID of the post
* @return This Sone (for method chaining)
*/
- public synchronized Sone removeLikedPostId(String postId) {
- likedPostIds.remove(postId);
- return this;
- }
+ public Sone removeLikedPostId(String postId);
/**
* Returns the IDs of all liked replies.
*
* @return All liked replies’ IDs
*/
- public Set<String> getLikedReplyIds() {
- return Collections.unmodifiableSet(likedReplyIds);
- }
+ public Set<String> getLikedReplyIds();
/**
* Sets the IDs of all liked replies.
* All liked replies’ IDs
* @return This Sone (for method chaining)
*/
- public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
- this.likedReplyIds.clear();
- this.likedReplyIds.addAll(likedReplyIds);
- return this;
- }
+ public Sone setLikeReplyIds(Set<String> likedReplyIds);
/**
* Checks whether the given reply ID is liked by this Sone.
* @return {@code true} if this Sone likes the given reply, {@code false}
* otherwise
*/
- public boolean isLikedReplyId(String replyId) {
- return likedReplyIds.contains(replyId);
- }
+ public boolean isLikedReplyId(String replyId);
/**
* Adds the given reply ID to the list of replies this Sone likes.
* The ID of the reply
* @return This Sone (for method chaining)
*/
- public synchronized Sone addLikedReplyId(String replyId) {
- likedReplyIds.add(replyId);
- return this;
- }
+ public Sone addLikedReplyId(String replyId);
/**
* Removes the given post ID from the list of replies this Sone likes.
* The ID of the reply
* @return This Sone (for method chaining)
*/
- public synchronized Sone removeLikedReplyId(String replyId) {
- likedReplyIds.remove(replyId);
- return this;
- }
+ public Sone removeLikedReplyId(String replyId);
/**
* Returns the albums of this Sone.
*
* @return The albums of this Sone
*/
- public List<Album> getAlbums() {
- return Collections.unmodifiableList(albums);
- }
+ public List<Album> getAlbums();
+
+ /**
+ * Returns a flattened list of all albums of this Sone. The resulting list
+ * contains parent albums before child albums so that the resulting list can
+ * be parsed in a single pass.
+ *
+ * @return The flattened albums
+ */
+ public List<Album> getAllAlbums();
+
+ /**
+ * Returns all images of a Sone. Images of a album are inserted into this
+ * list before images of all child albums.
+ *
+ * @return The list of all images
+ */
+ public List<Image> getAllImages();
/**
* Adds an album to this Sone.
* @param album
* The album to add
*/
- public synchronized void addAlbum(Album album) {
- Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).check();
- albums.add(album);
- }
+ public void addAlbum(Album album);
/**
* Sets the albums of this Sone.
* @param albums
* The albums of this Sone
*/
- public synchronized void setAlbums(Collection<? extends Album> albums) {
- Validation.begin().isNotNull("Albums", albums).check();
- this.albums.clear();
- for (Album album : albums) {
- addAlbum(album);
- }
- }
+ public void setAlbums(Collection<? extends Album> albums);
/**
* Removes an album from this Sone.
* @param album
* The album to remove
*/
- public synchronized void removeAlbum(Album album) {
- Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).check();
- albums.remove(album);
- }
+ public void removeAlbum(Album album);
/**
- * Returns Sone-specific options.
+ * Moves the given album up in this album’s albums. If the album is already
+ * the first album, nothing happens.
*
- * @return The options of this Sone
- */
- public Options getOptions() {
- return options;
- }
-
- //
- // FINGERPRINTABLE METHODS
- //
-
- /**
- * {@inheritDoc}
+ * @param album
+ * The album to move up
+ * @return The album that the given album swapped the place with, or
+ * <code>null</code> if the album did not change its place
*/
- @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(")");
-
- @SuppressWarnings("hiding")
- List<Reply> replies = new ArrayList<Reply>(getReplies());
- Collections.sort(replies, Reply.TIME_COMPARATOR);
- fingerprint.append("Replies(");
- for (Reply reply : replies) {
- fingerprint.append("Reply(").append(reply.getId()).append(')');
- }
- fingerprint.append(')');
-
- @SuppressWarnings("hiding")
- List<String> likedPostIds = new ArrayList<String>(getLikedPostIds());
- Collections.sort(likedPostIds);
- fingerprint.append("LikedPosts(");
- for (String likedPostId : likedPostIds) {
- fingerprint.append("Post(").append(likedPostId).append(')');
- }
- fingerprint.append(')');
-
- @SuppressWarnings("hiding")
- List<String> likedReplyIds = new ArrayList<String>(getLikedReplyIds());
- Collections.sort(likedReplyIds);
- fingerprint.append("LikedReplies(");
- for (String likedReplyId : likedReplyIds) {
- fingerprint.append("Reply(").append(likedReplyId).append(')');
- }
- fingerprint.append(')');
-
- fingerprint.append("Albums(");
- for (Album album : albums) {
- fingerprint.append(album.getFingerprint());
- }
- fingerprint.append(')');
-
- return fingerprint.toString();
- }
-
- //
- // STATIC METHODS
- //
+ public Album moveAlbumUp(Album album);
/**
- * Flattens the given top-level albums so that the resulting list contains
- * parent albums before child albums and the resulting list can be parsed in
- * a single pass.
+ * Moves the given album down in this album’s albums. If the album is
+ * already the last album, nothing happens.
*
- * @param albums
- * The albums to flatten
- * @return The flattened albums
- */
- public static List<Album> flattenAlbums(Collection<? extends Album> albums) {
- List<Album> flatAlbums = new ArrayList<Album>();
- flatAlbums.addAll(albums);
- int lastAlbumIndex = 0;
- while (lastAlbumIndex < flatAlbums.size()) {
- int previousAlbumCount = flatAlbums.size();
- for (Album album : new ArrayList<Album>(flatAlbums.subList(lastAlbumIndex, flatAlbums.size()))) {
- flatAlbums.addAll(album.getAlbums());
- }
- lastAlbumIndex = previousAlbumCount;
- }
- return flatAlbums;
- }
-
- //
- // INTERFACE Comparable<Sone>
- //
-
- /**
- * {@inheritDoc}
- */
- @Override
- public int compareTo(Sone sone) {
- return NICE_NAME_COMPARATOR.compare(this, sone);
- }
-
- //
- // OBJECT METHODS
- //
-
- /**
- * {@inheritDoc}
+ * @param album
+ * The album to move down
+ * @return The album that the given album swapped the place with, or
+ * <code>null</code> if the album did not change its place
*/
- @Override
- public int hashCode() {
- return id.hashCode();
- }
+ public Album moveAlbumDown(Album album);
/**
- * {@inheritDoc}
- */
- @Override
- public boolean equals(Object object) {
- if (!(object instanceof Sone)) {
- return false;
- }
- return ((Sone) object).id.equals(id);
- }
-
- /**
- * {@inheritDoc}
+ * Returns Sone-specific options.
+ *
+ * @return 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() + ")]";
- }
+ public Options getOptions();
}