X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdatabase%2Fmemory%2FMemorySone.java;fp=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdatabase%2Fmemory%2FMemorySone.java;h=1c5912f8a6a734cad70fb93647395d4279d8cff6;hb=c1fd1bc55bd809fd4ee447b2679bb8aafe4e06fc;hp=0000000000000000000000000000000000000000;hpb=827f78acf643d43be2cafdd05400b21908955e3f;p=Sone.git 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() + ")]"; + } + +}