X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fdata%2FSone.java;h=715d95b01e574f9927a4d45144963a7d7e036448;hb=07d3fa7dac96e8a5eff41487d647974df8c26f8d;hp=661a13c8ddd0b4cdcd03cf1e1f2c94b94fd0992e;hpb=dca29fe497ecbaefad9af7795309d2ec45ea15c8;p=Sone.git diff --git a/src/main/java/net/pterodactylus/sone/data/Sone.java b/src/main/java/net/pterodactylus/sone/data/Sone.java index 661a13c..836baa1 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 @@ /* - * FreenetSone - Sone.java - Copyright © 2010 David Roden + * Sone - Sone.java - Copyright © 2010–2020 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,619 +17,408 @@ package net.pterodactylus.sone.data; -import java.util.ArrayList; +import static com.google.common.collect.FluentIterable.from; +import static net.pterodactylus.sone.data.Album.FLATTENER; +import static net.pterodactylus.sone.data.Album.IMAGES; + import java.util.Collection; import java.util.Collections; -import java.util.Comparator; -import java.util.HashSet; import java.util.List; import java.util.Set; -import java.util.UUID; -import java.util.logging.Level; -import java.util.logging.Logger; -import net.pterodactylus.sone.template.SoneAccessor; -import net.pterodactylus.util.logging.Logging; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; + +import net.pterodactylus.sone.freenet.wot.Identity; + import freenet.keys.FreenetURI; +import com.google.common.base.Function; + /** * 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 { - - /** The logger. */ - private static final Logger logger = Logging.getLogger(Sone.class); - - /** A GUID for this Sone. */ - private final UUID id; - - /** The name of this Sone. */ - private String name; - - /** The URI under which the Sone is stored in Freenet. */ - private FreenetURI requestUri; +public interface Sone extends Identified, Fingerprintable, Comparable { - /** The URI used to insert a new version of this Sone. */ - /* This will be null for remote Sones! */ - private FreenetURI insertUri; - - /** The time of the last inserted update. */ - private long time; - - /** The profile of this Sone. */ - private Profile profile; - - /** All friend Sones. */ - private final Set friendSones = new HashSet(); - - /** All posts. */ - private final Set posts = new HashSet(); - - /** All replies. */ - private final Set replies = new HashSet(); - - /** The IDs of all blocked Sones. */ - private final Set blockedSoneIds = new HashSet(); + /** + * Enumeration for the possible states of a {@link Sone}. + */ + public enum SoneStatus { - /** The IDs of all liked posts. */ - private final Set likedPostIds = new HashSet(); + /** The Sone is unknown, i.e. not yet downloaded. */ + unknown, - /** The IDs of all liked replies. */ - private final Set likedReplyIds = new HashSet(); + /** The Sone is idle, i.e. not being downloaded or inserted. */ + idle, - /** Modification count. */ - private volatile long modificationCounter = 0; + /** The Sone is currently being inserted. */ + inserting, - /** - * Creates a new Sone. - * - * @param id - * The ID of this Sone - */ - public Sone(String id) { - this.id = UUID.fromString(id); + /** The Sone is currently being downloaded. */ + downloading, } - // - // ACCESSORS - // + public static final Function> toAllAlbums = new Function>() { + @Override + public List apply(@Nullable Sone sone) { + return (sone == null) ? Collections.emptyList() : FLATTENER.apply( + sone.getRootAlbum()); + } + }; + + 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 ID of this Sone. + * Returns the identity of this Sone. * - * @return The ID of this Sone + * @return The identity of this Sone */ - public String getId() { - return id.toString(); - } + @Nonnull + Identity getIdentity(); /** * Returns the name of this Sone. * * @return The name of this Sone */ - public String getName() { - return name; - } + @Nonnull + String getName(); /** - * Sets the name of this Sone. + * Returns whether this Sone is a local Sone. * - * @param name - * The name of this Sone - * @return This sone (for method chaining) + * @return {@code true} if this Sone is a local Sone, {@code false} otherwise */ - public Sone setName(String name) { - this.name = name; - return this; - } + boolean isLocal(); /** * Returns the request URI of this Sone. * * @return The request URI of this Sone */ - public FreenetURI getRequestUri() { - return requestUri; - } + @Nonnull + FreenetURI getRequestUri(); /** - * Sets the request URI of this Sone. + * Returns the latest edition of this Sone. * - * @param requestUri - * The request URI of this Sone - * @return This Sone (for method chaining) - */ - public Sone setRequestUri(FreenetURI requestUri) { - this.requestUri = requestUri; - return this; - } - - /** - * Returns the insert URI of this Sone. - * - * @return The insert URI of this Sone + * @return The latest edition of this Sone */ - public FreenetURI getInsertUri() { - return insertUri; - } + long getLatestEdition(); /** - * Sets the insert URI of this Sone. + * Sets the latest edition of this Sone. If the given latest edition is not + * greater than the current latest edition, the latest edition of this Sone is + * not changed. * - * @param insertUri - * The insert URI of this Sone - * @return This Sone (for method chaining) + * @param latestEdition + * The latest edition of this Sone */ - public Sone setInsertUri(FreenetURI insertUri) { - this.insertUri = insertUri; - return this; - } + 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. * * @param time - * The time of the update (in milliseconds since Jan 1, 1970 UTC) + * 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 a copy of the profile. If you want to update values in the - * profile of this Sone, update the values in the returned {@link Profile} - * and use {@link #setProfile(Profile)} to change the profile in this Sone. + * Returns the status of this Sone. + * + * @return The status of this Sone + */ + @Nonnull + 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} + */ + @Nonnull + Sone setStatus(@Nonnull SoneStatus status); + + /** + * Returns a copy of the profile. If you want to update values in the profile + * of this Sone, update the values in the returned {@link Profile} and use + * {@link #setProfile(Profile)} to change the profile in this Sone. * * @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 subsequent modifications of the given profile are not reflected in - * this Sone! + * Sets the profile of this Sone. A copy of the given profile is stored so that + * subsequent modifications of the given profile are not reflected in this + * Sone! * * @param profile - * The profile to set + * The profile to set */ - public synchronized void setProfile(Profile profile) { - this.profile = new Profile(profile); - modificationCounter++; - } + void setProfile(@Nonnull Profile profile); /** - * Returns all friend Sones of this Sone. + * Returns the client used by this Sone. * - * @return The friend Sones of this Sone + * @return The client used by this Sone, or {@code null} */ - public List getFriends() { - List friends = new ArrayList(friendSones); - Collections.sort(friends, new Comparator() { - - @Override - public int compare(Sone leftSone, Sone rightSone) { - int diff = SoneAccessor.getNiceName(leftSone).compareTo(SoneAccessor.getNiceName(rightSone)); - if (diff != 0) { - return diff; - } - return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightSone.getTime() - leftSone.getTime())); - } - }); - return friends; - } + @Nullable + Client getClient(); /** - * Sets all friends of this Sone at once. + * Sets the client used by this Sone. * - * @param friends - * The new (and only) friends of this Sone + * @param client + * The client used by this Sone, or {@code null} * @return This Sone (for method chaining) */ - public Sone setFriends(Collection friends) { - friendSones.clear(); - friendSones.addAll(friends); - return this; - } + @Nonnull + Sone setClient(@Nullable Client client); /** - * Returns whether this Sone has the given Sone as a friend Sone. + * Returns whether this Sone is known. * - * @param friendSone - * The friend Sone to check for - * @return {@code true} if this Sone has the given Sone as a friend, - * {@code false} otherwise + * @return {@code true} if this Sone is known, {@code false} otherwise */ - public boolean hasFriend(Sone friendSone) { - return friendSones.contains(friendSone); - } + boolean isKnown(); /** - * Adds the given Sone as a friend Sone. + * Sets whether this Sone is known. * - * @param friendSone - * The friend Sone to add - * @return This Sone (for method chaining) + * @param known + * {@code true} if this Sone is known, {@code false} otherwise + * @return This Sone */ - public Sone addFriend(Sone friendSone) { - if (!friendSone.equals(this)) { - friendSones.add(friendSone); - } - return this; - } + @Nonnull + Sone setKnown(boolean known); /** - * Removes the given Sone as a friend Sone. + * Returns all friend Sones of this Sone. * - * @param friendSone - * The friend Sone to remove - * @return This Sone (for method chaining) + * @return The friend Sones of this Sone */ - public Sone removeFriend(Sone friendSone) { - friendSones.remove(friendSone); - return this; - } + @Nonnull + Collection getFriends(); + + /** + * Returns whether this Sone has the given Sone as a friend Sone. + * + * @param friendSoneId + * The ID of the Sone to check for + * @return {@code true} if this Sone has the given Sone as a friend, {@code + * false} otherwise + */ + 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 = new ArrayList(posts); - Collections.sort(sortedPosts, new Comparator() { - - @Override - public int compare(Post leftPost, Post rightPost) { - return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime())); - } - - }); - return sortedPosts; - } + @Nonnull + List getPosts(); /** * Sets all posts of this Sone at once. * * @param posts - * The new (and only) posts of this Sone + * The new (and only) posts of this Sone * @return This Sone (for method chaining) */ - public synchronized Sone setPosts(Collection posts) { - this.posts.clear(); - this.posts.addAll(posts); - modificationCounter++; - return this; - } + @Nonnull + Sone setPosts(@Nonnull Collection posts); /** - * Adds the given post to this Sone. The post will not be added if its - * {@link Post#getSone() Sone} is not this Sone. + * Adds the given post to this Sone. The post will not be added if its {@link + * Post#getSone() Sone} is not this Sone. * * @param post - * The post to add + * The post to add */ - public synchronized void addPost(Post post) { - if (post.getSone().equals(this) && posts.add(post)) { - logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() }); - modificationCounter++; - } - } + void addPost(@Nonnull Post post); /** * Removes the given post from this Sone. * * @param post - * The post to remove + * The post to remove */ - public synchronized void removePost(Post post) { - if (post.getSone().equals(this) && posts.remove(post)) { - modificationCounter++; - } - } + void removePost(@Nonnull Post post); /** * Returns all replies this Sone made. * * @return All replies this Sone made */ - public Set getReplies() { - logger.log(Level.FINEST, "Friends of %s: %s", new Object[] { this, friendSones }); - return Collections.unmodifiableSet(replies); - } + @Nonnull + Set getReplies(); /** * Sets all replies of this Sone at once. * * @param replies - * The new (and only) replies of this Sone + * The new (and only) replies of this Sone * @return This Sone (for method chaining) */ - public synchronized Sone setReplies(Collection replies) { - this.replies.clear(); - this.replies.addAll(replies); - modificationCounter++; - return this; - } + @Nonnull + Sone setReplies(@Nonnull Collection replies); /** * Adds a reply to this Sone. If the given reply was not made by this Sone, * nothing is added to this Sone. * * @param reply - * The reply to add + * The reply to add */ - public synchronized void addReply(Reply reply) { - if (reply.getSone().equals(this) && replies.add(reply)) { - modificationCounter++; - } - } + void addReply(@Nonnull 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)) { - modificationCounter++; - } - } - - /** - * Returns the IDs of all blocked Sones. These Sones will not propagated - * using the “known Sones” mechanism. - * - * @return The IDs of all blocked Sones - */ - public Set getBlockedSoneIds() { - return Collections.unmodifiableSet(blockedSoneIds); - } - - /** - * Returns whether the given Sone ID is blocked. - * - * @param soneId - * The Sone ID to check - * @return {@code true} if the given Sone ID is blocked, {@code false} - * otherwise - */ - public boolean isSoneBlocked(String soneId) { - return blockedSoneIds.contains(soneId); - } - - /** - * Adds the given ID to the list of blocked IDs. - * - * @param soneId - * The Sone ID to block + * The reply to remove */ - public synchronized void addBlockedSoneId(String soneId) { - if (blockedSoneIds.add(soneId)) { - modificationCounter++; - } - } - - /** - * Removes the given ID from the list of blocked IDs. - * - * @param soneId - * The Sone ID to unblock - */ - public synchronized void removeBlockedSoneId(String soneId) { - if (blockedSoneIds.remove(soneId)) { - modificationCounter++; - } - } + 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. * * @param likedPostIds - * All liked posts’ IDs + * All liked posts’ IDs * @return This Sone (for method chaining) */ - public synchronized Sone setLikePostIds(Set likedPostIds) { - this.likedPostIds.clear(); - this.likedPostIds.addAll(likedPostIds); - modificationCounter++; - return this; - } + @Nonnull + Sone setLikePostIds(@Nonnull Set likedPostIds); /** * Checks whether the given post ID is liked by this Sone. * * @param postId - * The ID of the post + * The ID of the post * @return {@code true} if this Sone likes the given post, {@code false} * otherwise */ - public boolean isLikedPostId(String postId) { - return likedPostIds.contains(postId); - } + boolean isLikedPostId(@Nonnull String postId); /** * Adds the given post ID to the list of posts this Sone likes. * * @param postId - * The ID of the post + * The ID of the post * @return This Sone (for method chaining) */ - public synchronized Sone addLikedPostId(String postId) { - if (likedPostIds.add(postId)) { - modificationCounter++; - } - return this; - } + @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) + * The ID of the post */ - public synchronized Sone removeLikedPostId(String postId) { - if (likedPostIds.remove(postId)) { - modificationCounter++; - } - 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. * * @param likedReplyIds - * All liked replies’ IDs + * All liked replies’ IDs * @return This Sone (for method chaining) */ - public synchronized Sone setLikeReplyIds(Set likedReplyIds) { - this.likedReplyIds.clear(); - this.likedReplyIds.addAll(likedReplyIds); - modificationCounter++; - return this; - } + @Nonnull + Sone setLikeReplyIds(@Nonnull Set likedReplyIds); /** * Checks whether the given reply ID is liked by this Sone. * * @param replyId - * The ID of the reply + * The ID of the reply * @return {@code true} if this Sone likes the given reply, {@code false} * otherwise */ - public boolean isLikedReplyId(String replyId) { - return likedReplyIds.contains(replyId); - } + boolean isLikedReplyId(@Nonnull String replyId); /** * Adds the given reply ID to the list of replies this Sone likes. * * @param replyId - * The ID of the reply + * The ID of the reply * @return This Sone (for method chaining) */ - public synchronized Sone addLikedReplyId(String replyId) { - if (likedReplyIds.add(replyId)) { - modificationCounter++; - } - return this; - } + @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) + * The ID of the reply */ - public synchronized Sone removeLikedReplyId(String replyId) { - if (likedReplyIds.remove(replyId)) { - modificationCounter++; - } - return this; - } + void removeLikedReplyId(@Nonnull String replyId); /** - * Returns the modification counter. + * Returns the root album that contains all visible albums of this Sone. * - * @return The modification counter + * @return The root album of this Sone */ - public synchronized long getModificationCounter() { - return modificationCounter; - } + @Nonnull + Album getRootAlbum(); /** - * Sets the modification counter. + * Returns Sone-specific options. * - * @param modificationCounter - * The new modification counter + * @return The options of this Sone */ - public synchronized void setModificationCounter(long modificationCounter) { - this.modificationCounter = modificationCounter; - } + @Nonnull + SoneOptions getOptions(); /** - * Updates the suggested edition in both the request URI and the insert URI. + * Sets the options of this Sone. * - * @param requestUri - * The request URI that resulted from an insert + * @param options + * The options of this Sone */ - public void updateUris(FreenetURI requestUri) { - /* TODO - check for the correct URI. */ - long latestEdition = requestUri.getSuggestedEdition(); - this.requestUri = this.requestUri.setSuggestedEdition(latestEdition); - if (this.insertUri != null) { - this.insertUri = this.insertUri.setSuggestedEdition(latestEdition); - } - } - - // - // 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() + "[id=" + id + ",name=" + name + ",requestUri=" + requestUri + ",insertUri=" + insertUri + ",friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]"; - } + /* TODO - remove this method again, maybe add an option provider */ + void setOptions(@Nonnull SoneOptions options); }