X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FSone.java;h=b761c7bca81b7b91223de629856450eafcd65804;hp=31153ffe64cf3eaea2ea524898f4e2ab4f63936f;hb=ffd92ca2374c0b2218e583d02e0bdd24b8c110ae;hpb=7017646bf42cb265b6df539bb6def40b91d2f968 diff --git a/src/main/java/net/pterodactylus/sone/data/Sone.java b/src/main/java/net/pterodactylus/sone/data/Sone.java index 31153ff..b761c7b 100644 --- a/src/main/java/net/pterodactylus/sone/data/Sone.java +++ b/src/main/java/net/pterodactylus/sone/data/Sone.java @@ -1,5 +1,5 @@ /* - * Sone - Sone.java - Copyright © 2010–2013 David Roden + * Sone - Sone.java - Copyright © 2010–2016 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 @@ -17,44 +17,37 @@ package net.pterodactylus.sone.data; -import static com.google.common.base.Preconditions.checkNotNull; import static com.google.common.collect.FluentIterable.from; import static java.util.Arrays.asList; import static net.pterodactylus.sone.data.Album.FLATTENER; import static net.pterodactylus.sone.data.Album.IMAGES; -import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.Comparator; import java.util.List; import java.util.Set; -import java.util.concurrent.CopyOnWriteArraySet; -import java.util.logging.Level; -import java.util.logging.Logger; -import net.pterodactylus.sone.core.Options; +import 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.hash.Hasher; -import com.google.common.hash.Hashing; import com.google.common.primitives.Ints; /** * A Sone defines everything about a user: her profile, her status updates, her * replies, her likes and dislikes, etc. - *

- * Operations that modify the Sone need to synchronize on the Sone in question. * * @author David ‘Bombe’ Roden */ -public class Sone implements Identified, Fingerprintable, Comparable { +public interface Sone extends Identified, Fingerprintable, Comparable { /** * Enumeration for the possible states of a {@link Sone}. @@ -76,30 +69,6 @@ public class Sone implements Identified, Fingerprintable, Comparable { downloading, } - /** - * The possible values for the “show custom avatars” option. - * - * @author David ‘Bombe’ Roden - */ - 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 NICE_NAME_COMPARATOR = new Comparator() { @@ -155,7 +124,7 @@ public class Sone implements Identified, Fingerprintable, Comparable { @Override public boolean apply(Sone sone) { - return (sone == null) ? false : sone.getTime() != 0; + return (sone != null) && (sone.getTime() != 0); } }; @@ -164,7 +133,7 @@ public class Sone implements Identified, Fingerprintable, Comparable { @Override public boolean apply(Sone sone) { - return (sone == null) ? false : sone.getIdentity() instanceof OwnIdentity; + return (sone != null) && (sone.getIdentity() instanceof OwnIdentity); } }; @@ -174,203 +143,72 @@ public class Sone implements Identified, Fingerprintable, Comparable { @Override public boolean apply(Sone sone) { - return (sone == null) ? false : !sone.getRootAlbum().getAlbums().isEmpty(); + return (sone != null) && !sone.getRootAlbum().getAlbums().isEmpty(); } }; - /** The logger. */ - private static final Logger logger = Logging.getLogger(Sone.class); - - /** The ID of this Sone. */ - private final String id; - - /** Whether the Sone is local. */ - private final boolean local; - - /** The identity of this Sone. */ - private Identity identity; - - /** The 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 root album containing all albums. */ - private final Album rootAlbum = new Album().setSone(this); - - /** Sone-specific options. */ - private Options options = new Options(); - - /** - * Creates a new Sone. - * - * @param id - * The ID of the Sone - * @param local - * {@code true} if the Sone is a local Sone, {@code false} otherwise - */ - public Sone(String id, boolean local) { - this.id = id; - this.local = local; - } - - // - // ACCESSORS - // + public static final Function> toAllAlbums = new Function>() { + @Override + public List apply(@Nullable Sone sone) { + return (sone == null) ? Collections.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> toAllImages = new Function>() { + @Override + public List apply(@Nullable Sone sone) { + return (sone == null) ? Collections.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; - } + @Nonnull + Identity getIdentity(); /** * Returns the name of this Sone. * * @return The name of this Sone */ - public String getName() { - return (identity != null) ? identity.getNickname() : null; - } + @Nonnull + String getName(); /** * Returns whether this Sone is a local Sone. * * @return {@code true} if this Sone is a local Sone, {@code false} otherwise */ - public boolean isLocal() { - return local; - } + boolean isLocal(); /** * Returns the request URI of this Sone. * * @return The request URI of this Sone */ - public FreenetURI getRequestUri() { - return (requestUri != null) ? requestUri.setSuggestedEdition(latestEdition) : null; - } - - /** - * Sets the request URI of this Sone. - * - * @param requestUri - * 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; - } + @Nonnull + 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.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; - } + @Nullable + 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 @@ -380,22 +218,14 @@ public class Sone implements Identified, 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; - } + 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. @@ -404,19 +234,16 @@ public class Sone implements Identified, 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; - } + @Nonnull + Sone setTime(long time); /** * Returns the status of this Sone. * * @return The status of this Sone */ - public SoneStatus getStatus() { - return status; - } + @Nonnull + SoneStatus getStatus(); /** * Sets the new status of this Sone. @@ -427,10 +254,8 @@ public class Sone implements Identified, Fingerprintable, Comparable { * @throws IllegalArgumentException * if {@code status} is {@code null} */ - public Sone setStatus(SoneStatus status) { - this.status = checkNotNull(status, "status must not be null"); - return this; - } + @Nonnull + Sone setStatus(@Nonnull SoneStatus status); /** * Returns a copy of the profile. If you want to update values in the profile @@ -439,9 +264,8 @@ public class Sone implements Identified, Fingerprintable, Comparable { * * @return A copy of the profile */ - public Profile getProfile() { - return new Profile(profile); - } + @Nonnull + Profile getProfile(); /** * Sets the profile of this Sone. A copy of the given profile is stored so that @@ -451,18 +275,15 @@ public class Sone implements Identified, Fingerprintable, Comparable { * @param profile * The profile to set */ - public void setProfile(Profile profile) { - this.profile = new Profile(profile); - } + void setProfile(@Nonnull Profile profile); /** * Returns the client used by this Sone. * * @return The client used by this Sone, or {@code null} */ - public Client getClient() { - return client; - } + @Nullable + Client getClient(); /** * Sets the client used by this Sone. @@ -471,19 +292,15 @@ public class Sone implements Identified, 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; - } + @Nonnull + Sone setClient(@Nullable Client client); /** * Returns whether this Sone is known. * * @return {@code true} if this Sone is known, {@code false} otherwise */ - public boolean isKnown() { - return known; - } + boolean isKnown(); /** * Sets whether this Sone is known. @@ -492,20 +309,16 @@ public class Sone implements Identified, 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; - } + @Nonnull + 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; - } + @Nonnull + Collection getFriends(); /** * Returns whether this Sone has the given Sone as a friend Sone. @@ -515,49 +328,15 @@ public class Sone implements Identified, 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); - } - - /** - * Adds the given Sone as a friend Sone. - * - * @param friendSone - * 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; - } - - /** - * Removes the given Sone as a friend Sone. - * - * @param friendSoneId - * The ID of the friend Sone to remove - * @return This Sone (for method chaining) - */ - public Sone removeFriend(String friendSoneId) { - friendSones.remove(friendSoneId); - return this; - } + boolean hasFriend(@Nonnull 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; - } + @Nonnull + List getPosts(); /** * Sets all posts of this Sone at once. @@ -566,13 +345,8 @@ public class Sone implements Identified, 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; - } + @Nonnull + Sone setPosts(@Nonnull Collection posts); /** * Adds the given post to this Sone. The post will not be added if its {@link @@ -581,11 +355,7 @@ public class Sone implements Identified, 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())); - } - } + void addPost(@Nonnull Post post); /** * Removes the given post from this Sone. @@ -593,20 +363,15 @@ public class Sone implements Identified, Fingerprintable, Comparable { * @param post * The post to remove */ - public void removePost(Post post) { - if (post.getSone().equals(this)) { - posts.remove(post); - } - } + void removePost(@Nonnull Post post); /** * Returns all replies this Sone made. * * @return All replies this Sone made */ - public Set getReplies() { - return Collections.unmodifiableSet(replies); - } + @Nonnull + Set getReplies(); /** * Sets all replies of this Sone at once. @@ -615,11 +380,8 @@ public class Sone implements Identified, 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; - } + @Nonnull + Sone setReplies(@Nonnull Collection replies); /** * Adds a reply to this Sone. If the given reply was not made by this Sone, @@ -628,11 +390,7 @@ public class Sone implements Identified, Fingerprintable, Comparable { * @param reply * The reply to add */ - public void addReply(PostReply reply) { - if (reply.getSone().equals(this)) { - replies.add(reply); - } - } + void addReply(@Nonnull PostReply reply); /** * Removes a reply from this Sone. @@ -640,20 +398,15 @@ public class Sone implements Identified, Fingerprintable, Comparable { * @param reply * The reply to remove */ - public void removeReply(PostReply reply) { - if (reply.getSone().equals(this)) { - replies.remove(reply); - } - } + void removeReply(@Nonnull PostReply reply); /** * Returns the IDs of all liked posts. * * @return All liked posts’ IDs */ - public Set getLikedPostIds() { - return Collections.unmodifiableSet(likedPostIds); - } + @Nonnull + Set getLikedPostIds(); /** * Sets the IDs of all liked posts. @@ -662,11 +415,8 @@ public class Sone implements Identified, 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; - } + @Nonnull + Sone setLikePostIds(@Nonnull Set likedPostIds); /** * Checks whether the given post ID is liked by this Sone. @@ -676,9 +426,7 @@ public class Sone implements Identified, Fingerprintable, Comparable { * @return {@code true} if this Sone likes the given post, {@code false} * otherwise */ - public boolean isLikedPostId(String postId) { - return likedPostIds.contains(postId); - } + boolean isLikedPostId(@Nonnull String postId); /** * Adds the given post ID to the list of posts this Sone likes. @@ -687,31 +435,24 @@ public class Sone implements Identified, Fingerprintable, Comparable { * The ID of the post * @return This Sone (for method chaining) */ - public Sone addLikedPostId(String postId) { - likedPostIds.add(postId); - return this; - } + @Nonnull + Sone addLikedPostId(@Nonnull String postId); /** * Removes the given post ID from the list of posts this Sone likes. * * @param postId * The ID of the post - * @return This Sone (for method chaining) */ - public Sone removeLikedPostId(String postId) { - likedPostIds.remove(postId); - return this; - } + void removeLikedPostId(@Nonnull String postId); /** * Returns the IDs of all liked replies. * * @return All liked replies’ IDs */ - public Set getLikedReplyIds() { - return Collections.unmodifiableSet(likedReplyIds); - } + @Nonnull + Set getLikedReplyIds(); /** * Sets the IDs of all liked replies. @@ -720,11 +461,8 @@ public class Sone implements Identified, 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; - } + @Nonnull + Sone setLikeReplyIds(@Nonnull Set likedReplyIds); /** * Checks whether the given reply ID is liked by this Sone. @@ -734,9 +472,7 @@ public class Sone implements Identified, Fingerprintable, Comparable { * @return {@code true} if this Sone likes the given reply, {@code false} * otherwise */ - public boolean isLikedReplyId(String replyId) { - return likedReplyIds.contains(replyId); - } + boolean isLikedReplyId(@Nonnull String replyId); /** * Adds the given reply ID to the list of replies this Sone likes. @@ -745,40 +481,32 @@ public class Sone implements Identified, Fingerprintable, Comparable { * The ID of the reply * @return This Sone (for method chaining) */ - public Sone addLikedReplyId(String replyId) { - likedReplyIds.add(replyId); - return this; - } + @Nonnull + Sone addLikedReplyId(@Nonnull String replyId); /** * Removes the given post ID from the list of replies this Sone likes. * * @param replyId * The ID of the reply - * @return This Sone (for method chaining) */ - public Sone removeLikedReplyId(String replyId) { - likedReplyIds.remove(replyId); - return this; - } + void removeLikedReplyId(@Nonnull String replyId); /** * Returns the root album that contains all visible albums of this Sone. * * @return The root album of this Sone */ - public Album getRootAlbum() { - return rootAlbum; - } + @Nonnull + Album getRootAlbum(); /** * Returns Sone-specific options. * * @return The options of this Sone */ - public Options getOptions() { - return options; - } + @Nonnull + SoneOptions getOptions(); /** * Sets the options of this Sone. @@ -787,95 +515,6 @@ public class Sone implements Identified, Fingerprintable, Comparable { * The options of this Sone */ /* TODO - remove this method again, maybe add an option provider */ - public void setOptions(Options options) { - this.options = options; - } - - // - // FINGERPRINTABLE METHODS - // - - /** {@inheritDoc} */ - @Override - public synchronized String getFingerprint() { - Hasher hash = Hashing.sha256().newHasher(); - hash.putString(profile.getFingerprint()); - - hash.putString("Posts("); - for (Post post : getPosts()) { - hash.putString("Post(").putString(post.getId()).putString(")"); - } - hash.putString(")"); - - List replies = new ArrayList(getReplies()); - Collections.sort(replies, Reply.TIME_COMPARATOR); - hash.putString("Replies("); - for (PostReply reply : replies) { - hash.putString("Reply(").putString(reply.getId()).putString(")"); - } - hash.putString(")"); - - List likedPostIds = new ArrayList(getLikedPostIds()); - Collections.sort(likedPostIds); - hash.putString("LikedPosts("); - for (String likedPostId : likedPostIds) { - hash.putString("Post(").putString(likedPostId).putString(")"); - } - hash.putString(")"); - - List likedReplyIds = new ArrayList(getLikedReplyIds()); - Collections.sort(likedReplyIds); - hash.putString("LikedReplies("); - for (String likedReplyId : likedReplyIds) { - hash.putString("Reply(").putString(likedReplyId).putString(")"); - } - hash.putString(")"); - - hash.putString("Albums("); - for (Album album : rootAlbum.getAlbums()) { - if (!Album.NOT_EMPTY.apply(album)) { - continue; - } - hash.putString(album.getFingerprint()); - } - hash.putString(")"); - - return hash.hash().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() + "),albums(" + getRootAlbum().getAlbums().size() + ")]"; - } + void setOptions(@Nonnull SoneOptions options); }