From c1fd1bc55bd809fd4ee447b2679bb8aafe4e06fc Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?= Date: Wed, 30 May 2012 10:52:20 +0200 Subject: [PATCH] Turn Sone into an interface, add in-memory implementation of Sone. --- .../pterodactylus/sone/core/SoneDownloader.java | 3 +- .../java/net/pterodactylus/sone/data/Sone.java | 478 ++------------ .../sone/database/memory/MemoryDatabase.java | 4 +- .../sone/database/memory/MemorySone.java | 735 +++++++++++++++++++++ .../pterodactylus/sone/text/SoneTextParser.java | 3 +- .../sone/text/SoneTextParserTest.java | 3 +- 6 files changed, 796 insertions(+), 430 deletions(-) create mode 100644 src/main/java/net/pterodactylus/sone/database/memory/MemorySone.java diff --git a/src/main/java/net/pterodactylus/sone/core/SoneDownloader.java b/src/main/java/net/pterodactylus/sone/core/SoneDownloader.java index 59eaa78..f2d05ae 100644 --- a/src/main/java/net/pterodactylus/sone/core/SoneDownloader.java +++ b/src/main/java/net/pterodactylus/sone/core/SoneDownloader.java @@ -34,6 +34,7 @@ import net.pterodactylus.sone.data.PostReply; import net.pterodactylus.sone.data.Profile; import net.pterodactylus.sone.data.Sone; import net.pterodactylus.sone.data.Sone.SoneStatus; +import net.pterodactylus.sone.database.memory.MemorySone; import net.pterodactylus.util.collection.Pair; import net.pterodactylus.util.io.Closer; import net.pterodactylus.util.logging.Logging; @@ -236,7 +237,7 @@ public class SoneDownloader extends AbstractService { return null; } - Sone sone = new Sone(originalSone.getId(), originalSone.isLocal()).setIdentity(originalSone.getIdentity()); + Sone sone = new MemorySone(originalSone.getId(), originalSone.isLocal()).setIdentity(originalSone.getIdentity()); SimpleXML soneXml; try { diff --git a/src/main/java/net/pterodactylus/sone/data/Sone.java b/src/main/java/net/pterodactylus/sone/data/Sone.java index d515424..28a5afa 100644 --- a/src/main/java/net/pterodactylus/sone/data/Sone.java +++ b/src/main/java/net/pterodactylus/sone/data/Sone.java @@ -17,16 +17,10 @@ package net.pterodactylus.sone.data; -import java.util.ArrayList; import java.util.Collection; -import java.util.Collections; import java.util.Comparator; import java.util.List; import java.util.Set; -import java.util.concurrent.CopyOnWriteArrayList; -import java.util.concurrent.CopyOnWriteArraySet; -import java.util.logging.Level; -import java.util.logging.Logger; import net.pterodactylus.sone.core.Core; import net.pterodactylus.sone.core.Options; @@ -34,8 +28,6 @@ import net.pterodactylus.sone.freenet.wot.Identity; import net.pterodactylus.sone.freenet.wot.OwnIdentity; import net.pterodactylus.sone.template.SoneAccessor; import net.pterodactylus.util.collection.filter.Filter; -import net.pterodactylus.util.logging.Logging; -import net.pterodactylus.util.validation.Validation; import freenet.keys.FreenetURI; /** @@ -46,7 +38,7 @@ import freenet.keys.FreenetURI; * * @author David ‘Bombe’ Roden */ -public class Sone implements Fingerprintable, Comparable { +public interface Sone extends Fingerprintable, Comparable { /** * Enumeration for the possible states of a {@link Sone}. @@ -169,77 +161,6 @@ public class Sone implements Fingerprintable, Comparable { } }; - /** The logger. */ - private static final Logger logger = Logging.getLogger(Sone.class); - - /** The ID of this Sone. */ - private final String id; - - /** Whether this is a local Sone. */ - private final boolean local; - - /** 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 status of this Sone. */ - private volatile SoneStatus status = SoneStatus.unknown; - - /** The profile of this Sone. */ - 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 friendSones = new CopyOnWriteArraySet(); - - /** All posts. */ - private final Set posts = new CopyOnWriteArraySet(); - - /** All replies. */ - private final Set replies = new CopyOnWriteArraySet(); - - /** The IDs of all liked posts. */ - private final Set likedPostIds = new CopyOnWriteArraySet(); - - /** The IDs of all liked replies. */ - private final Set likedReplyIds = new CopyOnWriteArraySet(); - - /** The albums of this Sone. */ - private final List albums = new CopyOnWriteArrayList(); - - /** Sone-specific options. */ - private final Options options = new Options(); - - /** - * Creates a new Sone. - * - * @param id - * The ID of the Sone - * @param local - * {@code true} if this Sone is local, {@code false} otherwise - */ - public Sone(String id, boolean local) { - this.id = id; - this.local = local; - } - // // ACCESSORS // @@ -249,18 +170,14 @@ public class Sone implements Fingerprintable, Comparable { * * @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 @@ -272,40 +189,28 @@ public class Sone implements Fingerprintable, Comparable { * @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() { - return local; - } + 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. @@ -314,26 +219,14 @@ public class Sone implements Fingerprintable, Comparable { * 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, String.format("Request URI %s tried to overwrite %s!", 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. @@ -342,26 +235,14 @@ public class Sone implements Fingerprintable, Comparable { * 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, String.format("Request URI %s tried to overwrite %s!", 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 @@ -371,22 +252,14 @@ public class Sone implements Fingerprintable, Comparable { * @param latestEdition * The latest edition of this Sone */ - public void setLatestEdition(long latestEdition) { - if (!(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; - } + 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. @@ -395,19 +268,14 @@ public class Sone implements Fingerprintable, Comparable { * 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() { - return status; - } + public SoneStatus getStatus(); /** * Sets the new status of this Sone. @@ -418,11 +286,7 @@ public class Sone implements Fingerprintable, Comparable { * @throws IllegalArgumentException * if {@code status} is {@code null} */ - public Sone setStatus(SoneStatus status) { - Validation.begin().isNotNull("Sone Status", status).check(); - this.status = status; - return this; - } + public Sone setStatus(SoneStatus status); /** * Returns a copy of the profile. If you want to update values in the @@ -431,9 +295,7 @@ public class Sone implements Fingerprintable, Comparable { * * @return A copy of the profile */ - public Profile getProfile() { - return new Profile(profile); - } + public Profile getProfile(); /** * Sets the profile of this Sone. A copy of the given profile is stored so @@ -443,18 +305,14 @@ public class Sone implements Fingerprintable, Comparable { * @param profile * The profile to set */ - public 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. @@ -463,19 +321,14 @@ public class Sone implements Fingerprintable, Comparable { * 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 whether this Sone is known. * * @return {@code true} if this Sone is known, {@code false} otherwise */ - public boolean isKnown() { - return known; - } + public boolean isKnown(); /** * Sets whether this Sone is known. @@ -484,20 +337,14 @@ public class Sone implements Fingerprintable, Comparable { * {@code true} if this Sone is known, {@code false} otherwise * @return This Sone */ - public Sone setKnown(boolean known) { - this.known = known; - return this; - } + public Sone setKnown(boolean known); /** * Returns all friend Sones of this Sone. * * @return The friend Sones of this Sone */ - public List getFriends() { - List friends = new ArrayList(friendSones); - return friends; - } + public Collection getFriends(); /** * Returns whether this Sone has the given Sone as a friend Sone. @@ -507,9 +354,7 @@ public class Sone implements Fingerprintable, Comparable { * @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. @@ -518,12 +363,7 @@ public class Sone implements Fingerprintable, Comparable { * 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. @@ -532,24 +372,14 @@ public class Sone implements Fingerprintable, Comparable { * 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 getPosts() { - List sortedPosts; - synchronized (this) { - sortedPosts = new ArrayList(posts); - } - Collections.sort(sortedPosts, Post.TIME_COMPARATOR); - return sortedPosts; - } + public List getPosts(); /** * Sets all posts of this Sone at once. @@ -558,13 +388,7 @@ public class Sone implements Fingerprintable, Comparable { * The new (and only) posts of this Sone * @return This Sone (for method chaining) */ - public Sone setPosts(Collection posts) { - synchronized (this) { - this.posts.clear(); - this.posts.addAll(posts); - } - return this; - } + public Sone setPosts(Collection posts); /** * Adds the given post to this Sone. The post will not be added if its @@ -573,11 +397,7 @@ public class Sone implements Fingerprintable, Comparable { * @param post * The post to add */ - public void addPost(Post post) { - if (post.getSone().equals(this) && posts.add(post)) { - logger.log(Level.FINEST, String.format("Adding %s to “%s”.", post, getName())); - } - } + public void addPost(Post post); /** * Removes the given post from this Sone. @@ -585,20 +405,14 @@ public class Sone implements Fingerprintable, Comparable { * @param post * The post to remove */ - public 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 Set getReplies() { - return Collections.unmodifiableSet(replies); - } + public Set getReplies(); /** * Sets all replies of this Sone at once. @@ -607,11 +421,7 @@ public class Sone implements Fingerprintable, Comparable { * The new (and only) replies of this Sone * @return This Sone (for method chaining) */ - public Sone setReplies(Collection replies) { - this.replies.clear(); - this.replies.addAll(replies); - return this; - } + public Sone setReplies(Collection replies); /** * Adds a reply to this Sone. If the given reply was not made by this Sone, @@ -620,11 +430,7 @@ public class Sone implements Fingerprintable, Comparable { * @param reply * The reply to add */ - public void addReply(PostReply reply) { - if (reply.getSone().equals(this)) { - replies.add(reply); - } - } + public void addReply(PostReply reply); /** * Removes a reply from this Sone. @@ -632,20 +438,14 @@ public class Sone implements Fingerprintable, Comparable { * @param reply * The reply to remove */ - public void removeReply(PostReply 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 getLikedPostIds() { - return Collections.unmodifiableSet(likedPostIds); - } + public Set getLikedPostIds(); /** * Sets the IDs of all liked posts. @@ -654,11 +454,7 @@ public class Sone implements Fingerprintable, Comparable { * All liked posts’ IDs * @return This Sone (for method chaining) */ - public Sone setLikePostIds(Set likedPostIds) { - this.likedPostIds.clear(); - this.likedPostIds.addAll(likedPostIds); - return this; - } + public Sone setLikePostIds(Set likedPostIds); /** * Checks whether the given post ID is liked by this Sone. @@ -668,9 +464,7 @@ public class Sone implements Fingerprintable, Comparable { * @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. @@ -679,10 +473,7 @@ public class Sone implements Fingerprintable, Comparable { * The ID of the post * @return This Sone (for method chaining) */ - public 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. @@ -691,19 +482,14 @@ public class Sone implements Fingerprintable, Comparable { * The ID of the post * @return This Sone (for method chaining) */ - public 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 getLikedReplyIds() { - return Collections.unmodifiableSet(likedReplyIds); - } + public Set getLikedReplyIds(); /** * Sets the IDs of all liked replies. @@ -712,11 +498,7 @@ public class Sone implements Fingerprintable, Comparable { * All liked replies’ IDs * @return This Sone (for method chaining) */ - public Sone setLikeReplyIds(Set likedReplyIds) { - this.likedReplyIds.clear(); - this.likedReplyIds.addAll(likedReplyIds); - return this; - } + public Sone setLikeReplyIds(Set likedReplyIds); /** * Checks whether the given reply ID is liked by this Sone. @@ -726,9 +508,7 @@ public class Sone implements Fingerprintable, Comparable { * @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. @@ -737,10 +517,7 @@ public class Sone implements Fingerprintable, Comparable { * The ID of the reply * @return This Sone (for method chaining) */ - public 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. @@ -749,19 +526,14 @@ public class Sone implements Fingerprintable, Comparable { * The ID of the reply * @return This Sone (for method chaining) */ - public 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 getAlbums() { - return Collections.unmodifiableList(albums); - } + public List getAlbums(); /** * Returns a flattened list of all albums of this Sone. The resulting list @@ -770,19 +542,7 @@ public class Sone implements Fingerprintable, Comparable { * * @return The flattened albums */ - public List getAllAlbums() { - List flatAlbums = new ArrayList(); - flatAlbums.addAll(albums); - int lastAlbumIndex = 0; - while (lastAlbumIndex < flatAlbums.size()) { - int previousAlbumCount = flatAlbums.size(); - for (Album album : new ArrayList(flatAlbums.subList(lastAlbumIndex, flatAlbums.size()))) { - flatAlbums.addAll(album.getAlbums()); - } - lastAlbumIndex = previousAlbumCount; - } - return flatAlbums; - } + public List getAllAlbums(); /** * Returns all images of a Sone. Images of a album are inserted into this @@ -790,13 +550,7 @@ public class Sone implements Fingerprintable, Comparable { * * @return The list of all images */ - public List getAllImages() { - List allImages = new ArrayList(); - for (Album album : getAllAlbums()) { - allImages.addAll(album.getImages()); - } - return allImages; - } + public List getAllImages(); /** * Adds an album to this Sone. @@ -804,10 +558,7 @@ public class Sone implements Fingerprintable, Comparable { * @param album * The album to add */ - public 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. @@ -815,13 +566,7 @@ public class Sone implements Fingerprintable, Comparable { * @param albums * The albums of this Sone */ - public void setAlbums(Collection albums) { - Validation.begin().isNotNull("Albums", albums).check(); - this.albums.clear(); - for (Album album : albums) { - addAlbum(album); - } - } + public void setAlbums(Collection albums); /** * Removes an album from this Sone. @@ -829,10 +574,7 @@ public class Sone implements Fingerprintable, Comparable { * @param album * The album to remove */ - public 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); /** * Moves the given album up in this album’s albums. If the album is already @@ -843,16 +585,7 @@ public class Sone implements Fingerprintable, Comparable { * @return The album that the given album swapped the place with, or * null if the album did not change its place */ - public Album moveAlbumUp(Album album) { - Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).isNull("Album Parent", album.getParent()).check(); - int oldIndex = albums.indexOf(album); - if (oldIndex <= 0) { - return null; - } - albums.remove(oldIndex); - albums.add(oldIndex - 1, album); - return albums.get(oldIndex); - } + public Album moveAlbumUp(Album album); /** * Moves the given album down in this album’s albums. If the album is @@ -863,118 +596,13 @@ public class Sone implements Fingerprintable, Comparable { * @return The album that the given album swapped the place with, or * null if the album did not change its place */ - public Album moveAlbumDown(Album album) { - Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).isNull("Album Parent", album.getParent()).check(); - int oldIndex = albums.indexOf(album); - if ((oldIndex < 0) || (oldIndex >= (albums.size() - 1))) { - return null; - } - albums.remove(oldIndex); - albums.add(oldIndex + 1, album); - return albums.get(oldIndex); - } + public Album moveAlbumDown(Album album); /** * 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 (PostReply 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(')'); - - fingerprint.append("Albums("); - for (Album album : albums) { - fingerprint.append(album.getFingerprint()); - } - fingerprint.append(')'); - - return fingerprint.toString(); - } - - // - // INTERFACE Comparable - // - - /** - * {@inheritDoc} - */ - @Override - public int compareTo(Sone sone) { - return NICE_NAME_COMPARATOR.compare(this, sone); - } - - // - // OBJECT METHODS - // - - /** - * {@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} - */ - @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(); } diff --git a/src/main/java/net/pterodactylus/sone/database/memory/MemoryDatabase.java b/src/main/java/net/pterodactylus/sone/database/memory/MemoryDatabase.java index 3c32f71..db295e8 100644 --- a/src/main/java/net/pterodactylus/sone/database/memory/MemoryDatabase.java +++ b/src/main/java/net/pterodactylus/sone/database/memory/MemoryDatabase.java @@ -91,7 +91,7 @@ public class MemoryDatabase implements Database { Validation.begin().isNotNull("Sone ID", id).check(); synchronized (localSones) { if (!localSones.containsKey(id) && create) { - localSones.put(id, new Sone(id, true)); + localSones.put(id, new MemorySone(id, true)); } return localSones.get(id); } @@ -105,7 +105,7 @@ public class MemoryDatabase implements Database { Validation.begin().isNotNull("Sone ID", id).check(); synchronized (remoteSones) { if (!remoteSones.containsKey(id) && create) { - remoteSones.put(id, new Sone(id, false)); + remoteSones.put(id, new MemorySone(id, false)); } return remoteSones.get(id); } diff --git a/src/main/java/net/pterodactylus/sone/database/memory/MemorySone.java b/src/main/java/net/pterodactylus/sone/database/memory/MemorySone.java new file mode 100644 index 0000000..1c5912f --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/database/memory/MemorySone.java @@ -0,0 +1,735 @@ +/* + * Sone - MemorySone.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 + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.sone.database.memory; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Set; +import java.util.concurrent.CopyOnWriteArrayList; +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.data.Album; +import net.pterodactylus.sone.data.Client; +import net.pterodactylus.sone.data.Image; +import net.pterodactylus.sone.data.Post; +import net.pterodactylus.sone.data.PostReply; +import net.pterodactylus.sone.data.Profile; +import net.pterodactylus.sone.data.Reply; +import net.pterodactylus.sone.data.Sone; +import net.pterodactylus.sone.database.Database; +import net.pterodactylus.sone.freenet.wot.Identity; +import net.pterodactylus.util.logging.Logging; +import net.pterodactylus.util.validation.Validation; +import freenet.keys.FreenetURI; + +/** + * Implementation of a {@link Sone} that keeps all added data in memory. A + * self-created instance of this class should be converted to a {@link Database} + * -based instance of {@link Sone} as soon as possible (unless it was returned + * by a {@link MemoryDatabase}). + * + * @author David ‘Bombe’ Roden + */ +public class MemorySone implements Sone { + + /** The logger. */ + private static final Logger logger = Logging.getLogger(Sone.class); + + /** The ID of this Sone. */ + private final String id; + + /** Whether this is a local Sone. */ + private final boolean local; + + /** 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 status of this Sone. */ + private volatile SoneStatus status = SoneStatus.unknown; + + /** The profile of this Sone. */ + 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 friendSones = new CopyOnWriteArraySet(); + + /** All posts. */ + private final Set posts = new CopyOnWriteArraySet(); + + /** All replies. */ + private final Set replies = new CopyOnWriteArraySet(); + + /** The IDs of all liked posts. */ + private final Set likedPostIds = new CopyOnWriteArraySet(); + + /** The IDs of all liked replies. */ + private final Set likedReplyIds = new CopyOnWriteArraySet(); + + /** The albums of this Sone. */ + private final List albums = new CopyOnWriteArrayList(); + + /** Sone-specific options. */ + private final Options options = new Options(); + + /** + * Creates a new Sone. + * + * @param id + * The ID of the Sone + * @param local + * {@code true} if this Sone is local, {@code false} otherwise + */ + public MemorySone(String id, boolean local) { + this.id = id; + this.local = local; + } + + // + // ACCESSORS + // + + /** + * {@inheritDoc} + */ + @Override + public String getId() { + return id; + } + + /** + * {@inheritDoc} + */ + @Override + public Identity getIdentity() { + return identity; + } + + /** + * {@inheritDoc} + */ + @Override + 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; + } + + /** + * {@inheritDoc} + */ + @Override + public boolean isLocal() { + return local; + } + + /** + * {@inheritDoc} + */ + @Override + public String getName() { + return (identity != null) ? identity.getNickname() : null; + } + + /** + * {@inheritDoc} + */ + @Override + public FreenetURI getRequestUri() { + return (requestUri != null) ? requestUri.setSuggestedEdition(latestEdition) : null; + } + + /** + * {@inheritDoc} + */ + @Override + 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, String.format("Request URI %s tried to overwrite %s!", requestUri, this.requestUri)); + return this; + } + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public FreenetURI getInsertUri() { + return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null; + } + + /** + * {@inheritDoc} + */ + @Override + 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, String.format("Request URI %s tried to overwrite %s!", insertUri, this.insertUri)); + return this; + } + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public long getLatestEdition() { + return latestEdition; + } + + /** + * {@inheritDoc} + */ + @Override + public void setLatestEdition(long latestEdition) { + if (!(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; + } + + /** + * {@inheritDoc} + */ + @Override + public long getTime() { + return time; + } + + /** + * {@inheritDoc} + */ + @Override + public Sone setTime(long time) { + this.time = time; + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public SoneStatus getStatus() { + return status; + } + + /** + * {@inheritDoc} + */ + @Override + public Sone setStatus(SoneStatus status) { + Validation.begin().isNotNull("Sone Status", status).check(); + this.status = status; + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public Profile getProfile() { + return new Profile(profile); + } + + /** + * {@inheritDoc} + */ + @Override + public void setProfile(Profile profile) { + this.profile = new Profile(profile); + } + + /** + * {@inheritDoc} + */ + @Override + public Client getClient() { + return client; + } + + /** + * {@inheritDoc} + */ + @Override + public Sone setClient(Client client) { + this.client = client; + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public boolean isKnown() { + return known; + } + + /** + * {@inheritDoc} + */ + @Override + public Sone setKnown(boolean known) { + this.known = known; + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public List getFriends() { + List friends = new ArrayList(friendSones); + return friends; + } + + /** + * {@inheritDoc} + */ + @Override + public boolean hasFriend(String friendSoneId) { + return friendSones.contains(friendSoneId); + } + + /** + * {@inheritDoc} + */ + @Override + public Sone addFriend(String friendSone) { + if (!friendSone.equals(id)) { + friendSones.add(friendSone); + } + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public Sone removeFriend(String friendSoneId) { + friendSones.remove(friendSoneId); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public List getPosts() { + List sortedPosts; + synchronized (this) { + sortedPosts = new ArrayList(posts); + } + Collections.sort(sortedPosts, Post.TIME_COMPARATOR); + return sortedPosts; + } + + /** + * {@inheritDoc} + */ + @Override + public Sone setPosts(Collection posts) { + synchronized (this) { + this.posts.clear(); + this.posts.addAll(posts); + } + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public void addPost(Post post) { + if (post.getSone().equals(this) && posts.add(post)) { + logger.log(Level.FINEST, String.format("Adding %s to “%s”.", post, getName())); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void removePost(Post post) { + if (post.getSone().equals(this)) { + posts.remove(post); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Set getReplies() { + return Collections.unmodifiableSet(replies); + } + + /** + * {@inheritDoc} + */ + @Override + public Sone setReplies(Collection replies) { + this.replies.clear(); + this.replies.addAll(replies); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public void addReply(PostReply reply) { + if (reply.getSone().equals(this)) { + replies.add(reply); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void removeReply(PostReply reply) { + if (reply.getSone().equals(this)) { + replies.remove(reply); + } + } + + /** + * {@inheritDoc} + */ + @Override + public Set getLikedPostIds() { + return Collections.unmodifiableSet(likedPostIds); + } + + /** + * {@inheritDoc} + */ + @Override + public Sone setLikePostIds(Set likedPostIds) { + this.likedPostIds.clear(); + this.likedPostIds.addAll(likedPostIds); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public boolean isLikedPostId(String postId) { + return likedPostIds.contains(postId); + } + + /** + * {@inheritDoc} + */ + @Override + public Sone addLikedPostId(String postId) { + likedPostIds.add(postId); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public Sone removeLikedPostId(String postId) { + likedPostIds.remove(postId); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public Set getLikedReplyIds() { + return Collections.unmodifiableSet(likedReplyIds); + } + + /** + * {@inheritDoc} + */ + @Override + public Sone setLikeReplyIds(Set likedReplyIds) { + this.likedReplyIds.clear(); + this.likedReplyIds.addAll(likedReplyIds); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public boolean isLikedReplyId(String replyId) { + return likedReplyIds.contains(replyId); + } + + /** + * {@inheritDoc} + */ + @Override + public Sone addLikedReplyId(String replyId) { + likedReplyIds.add(replyId); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public Sone removeLikedReplyId(String replyId) { + likedReplyIds.remove(replyId); + return this; + } + + /** + * {@inheritDoc} + */ + @Override + public List getAlbums() { + return Collections.unmodifiableList(albums); + } + + /** + * {@inheritDoc} + */ + @Override + public List getAllAlbums() { + List flatAlbums = new ArrayList(); + flatAlbums.addAll(albums); + int lastAlbumIndex = 0; + while (lastAlbumIndex < flatAlbums.size()) { + int previousAlbumCount = flatAlbums.size(); + for (Album album : new ArrayList(flatAlbums.subList(lastAlbumIndex, flatAlbums.size()))) { + flatAlbums.addAll(album.getAlbums()); + } + lastAlbumIndex = previousAlbumCount; + } + return flatAlbums; + } + + /** + * {@inheritDoc} + */ + @Override + public List getAllImages() { + List allImages = new ArrayList(); + for (Album album : getAllAlbums()) { + allImages.addAll(album.getImages()); + } + return allImages; + } + + /** + * {@inheritDoc} + */ + @Override + public void addAlbum(Album album) { + Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).check(); + albums.add(album); + } + + /** + * {@inheritDoc} + */ + @Override + public void setAlbums(Collection albums) { + Validation.begin().isNotNull("Albums", albums).check(); + this.albums.clear(); + for (Album album : albums) { + addAlbum(album); + } + } + + /** + * {@inheritDoc} + */ + @Override + public void removeAlbum(Album album) { + Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).check(); + albums.remove(album); + } + + /** + * {@inheritDoc} + */ + @Override + public Album moveAlbumUp(Album album) { + Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).isNull("Album Parent", album.getParent()).check(); + int oldIndex = albums.indexOf(album); + if (oldIndex <= 0) { + return null; + } + albums.remove(oldIndex); + albums.add(oldIndex - 1, album); + return albums.get(oldIndex); + } + + /** + * {@inheritDoc} + */ + @Override + public Album moveAlbumDown(Album album) { + Validation.begin().isNotNull("Album", album).check().isEqual("Album Owner", album.getSone(), this).isNull("Album Parent", album.getParent()).check(); + int oldIndex = albums.indexOf(album); + if ((oldIndex < 0) || (oldIndex >= (albums.size() - 1))) { + return null; + } + albums.remove(oldIndex); + albums.add(oldIndex + 1, album); + return albums.get(oldIndex); + } + + /** + * {@inheritDoc} + */ + @Override + 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 (PostReply 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(')'); + + fingerprint.append("Albums("); + for (Album album : albums) { + fingerprint.append(album.getFingerprint()); + } + fingerprint.append(')'); + + return fingerprint.toString(); + } + + // + // INTERFACE Comparable + // + + /** + * {@inheritDoc} + */ + @Override + public int compareTo(Sone sone) { + return NICE_NAME_COMPARATOR.compare(this, sone); + } + + // + // OBJECT METHODS + // + + /** + * {@inheritDoc} + */ + @Override + public int hashCode() { + return id.hashCode(); + } + + /** + * {@inheritDoc} + */ + @Override + public boolean equals(Object object) { + if (!(object instanceof Sone)) { + return false; + } + return ((Sone) object).getId().equals(id); + } + + /** + * {@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() + ")]"; + } + +} diff --git a/src/main/java/net/pterodactylus/sone/text/SoneTextParser.java b/src/main/java/net/pterodactylus/sone/text/SoneTextParser.java index cb23948..558edb0 100644 --- a/src/main/java/net/pterodactylus/sone/text/SoneTextParser.java +++ b/src/main/java/net/pterodactylus/sone/text/SoneTextParser.java @@ -30,6 +30,7 @@ import net.pterodactylus.sone.core.PostProvider; import net.pterodactylus.sone.core.SoneProvider; import net.pterodactylus.sone.data.Post; import net.pterodactylus.sone.data.Sone; +import net.pterodactylus.sone.database.memory.MemorySone; import net.pterodactylus.util.logging.Logging; import freenet.keys.FreenetURI; @@ -207,7 +208,7 @@ public class SoneTextParser implements Parser { * don’t use create=true above, we don’t want the * empty shell. */ - sone = new Sone(soneId, false); + sone = new MemorySone(soneId, false); } parts.add(new SonePart(sone)); line = line.substring(50); diff --git a/src/test/java/net/pterodactylus/sone/text/SoneTextParserTest.java b/src/test/java/net/pterodactylus/sone/text/SoneTextParserTest.java index 9b1d11d..4f9f002 100644 --- a/src/test/java/net/pterodactylus/sone/text/SoneTextParserTest.java +++ b/src/test/java/net/pterodactylus/sone/text/SoneTextParserTest.java @@ -23,6 +23,7 @@ import java.io.StringReader; import junit.framework.TestCase; import net.pterodactylus.sone.core.SoneProvider; import net.pterodactylus.sone.data.Sone; +import net.pterodactylus.sone.database.memory.MemorySone; /** * JUnit test case for {@link SoneTextParser}. @@ -161,7 +162,7 @@ public class SoneTextParserTest extends TestCase { */ @Override public Sone getSone(final String soneId, boolean create) { - return new Sone(soneId, false) { + return new MemorySone(soneId, false) { /** * {@inheritDoc} -- 2.7.4