2 * FreenetSone - Sone.java - Copyright © 2010 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.data;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.Comparator;
24 import java.util.HashSet;
25 import java.util.List;
27 import java.util.logging.Level;
28 import java.util.logging.Logger;
30 import net.pterodactylus.sone.freenet.wot.Identity;
31 import net.pterodactylus.sone.template.SoneAccessor;
32 import net.pterodactylus.util.logging.Logging;
33 import freenet.keys.FreenetURI;
36 * A Sone defines everything about a user: her profile, her status updates, her
37 * replies, her likes and dislikes, etc.
39 * Operations that modify the Sone need to synchronize on the Sone in question.
41 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
45 /** comparator that sorts Sones by their nice name. */
46 public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
49 public int compare(Sone leftSone, Sone rightSone) {
50 int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
54 return leftSone.getId().compareToIgnoreCase(rightSone.getId());
60 private static final Logger logger = Logging.getLogger(Sone.class);
62 /** The ID of this Sone. */
63 private final String id;
65 /** The identity of this Sone. */
66 private Identity identity;
68 /** The URI under which the Sone is stored in Freenet. */
69 private volatile FreenetURI requestUri;
71 /** The URI used to insert a new version of this Sone. */
72 /* This will be null for remote Sones! */
73 private volatile FreenetURI insertUri;
75 /** The latest edition of the Sone. */
76 private volatile long latestEdition;
78 /** The time of the last inserted update. */
79 private volatile long time;
81 /** The profile of this Sone. */
82 private volatile Profile profile;
84 /** All friend Sones. */
85 private final Set<Sone> friendSones = Collections.synchronizedSet(new HashSet<Sone>());
88 private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
91 private final Set<Reply> replies = Collections.synchronizedSet(new HashSet<Reply>());
93 /** The IDs of all liked posts. */
94 private final Set<String> likedPostIds = Collections.synchronizedSet(new HashSet<String>());
96 /** The IDs of all liked replies. */
97 private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
99 /** Modification count. */
100 private volatile long modificationCounter = 0;
103 * Creates a new Sone.
108 public Sone(String id) {
117 * Returns the identity of this Sone.
119 * @return The identity of this Sone
121 public String getId() {
126 * Returns the identity of this Sone.
128 * @return The identity of this Sone
130 public Identity getIdentity() {
135 * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
136 * identity has to match this Sone’s {@link #getId()}.
139 * The identity of this Sone
140 * @return This Sone (for method chaining)
141 * @throws IllegalArgumentException
142 * if the ID of the identity does not match this Sone’s ID
144 public Sone setIdentity(Identity identity) throws IllegalArgumentException {
145 if (!identity.getId().equals(id)) {
146 throw new IllegalArgumentException("Identity’s ID does not match Sone’s ID!");
148 this.identity = identity;
153 * Returns the name of this Sone.
155 * @return The name of this Sone
157 public String getName() {
158 return (identity != null) ? identity.getNickname() : null;
162 * Returns the request URI of this Sone.
164 * @return The request URI of this Sone
166 public FreenetURI getRequestUri() {
167 return requestUri.setSuggestedEdition(latestEdition);
171 * Sets the request URI of this Sone.
174 * The request URI of this Sone
175 * @return This Sone (for method chaining)
177 public Sone setRequestUri(FreenetURI requestUri) {
178 if (this.requestUri == null) {
179 this.requestUri = requestUri.setDocName("Sone").setMetaString(new String[0]);
182 if (!this.requestUri.equalsKeypair(requestUri)) {
183 logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { requestUri, this.requestUri });
186 setLatestEdition(requestUri.getEdition());
191 * Returns the insert URI of this Sone.
193 * @return The insert URI of this Sone
195 public FreenetURI getInsertUri() {
196 return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null;
200 * Sets the insert URI of this Sone.
203 * The insert URI of this Sone
204 * @return This Sone (for method chaining)
206 public Sone setInsertUri(FreenetURI insertUri) {
207 if (this.insertUri == null) {
208 this.insertUri = insertUri.setDocName("Sone").setMetaString(new String[0]);
211 if (!this.insertUri.equalsKeypair(insertUri)) {
212 logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { insertUri, this.insertUri });
215 setLatestEdition(insertUri.getEdition());
220 * Returns the latest edition of this Sone.
222 * @return The latest edition of this Sone
224 public long getLatestEdition() {
225 return latestEdition;
229 * Sets the latest edition of this Sone. If the given latest edition is not
230 * greater than the current latest edition, the latest edition of this Sone
233 * @param latestEdition
234 * The latest edition of this Sone
236 public void setLatestEdition(long latestEdition) {
237 if (!(latestEdition > this.latestEdition)) {
238 logger.log(Level.INFO, "New latest edition %d is not greater than current latest edition %d!", new Object[] { latestEdition, this.latestEdition });
241 this.latestEdition = latestEdition;
245 * Return the time of the last inserted update of this Sone.
247 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
249 public long getTime() {
254 * Sets the time of the last inserted update of this Sone.
257 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
258 * @return This Sone (for method chaining)
260 public Sone setTime(long time) {
266 * Returns a copy of the profile. If you want to update values in the
267 * profile of this Sone, update the values in the returned {@link Profile}
268 * and use {@link #setProfile(Profile)} to change the profile in this Sone.
270 * @return A copy of the profile
272 public Profile getProfile() {
273 return new Profile(profile);
277 * Sets the profile of this Sone. A copy of the given profile is stored so
278 * that subsequent modifications of the given profile are not reflected in
284 public synchronized void setProfile(Profile profile) {
285 this.profile = new Profile(profile);
286 modificationCounter++;
290 * Returns all friend Sones of this Sone.
292 * @return The friend Sones of this Sone
294 public List<Sone> getFriends() {
295 List<Sone> friends = new ArrayList<Sone>(friendSones);
296 Collections.sort(friends, new Comparator<Sone>() {
299 public int compare(Sone leftSone, Sone rightSone) {
300 int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
304 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightSone.getTime() - leftSone.getTime()));
311 * Sets all friends of this Sone at once.
314 * The new (and only) friends of this Sone
315 * @return This Sone (for method chaining)
317 public Sone setFriends(Collection<Sone> friends) {
319 friendSones.addAll(friends);
324 * Returns whether this Sone has the given Sone as a friend Sone.
327 * The friend Sone to check for
328 * @return {@code true} if this Sone has the given Sone as a friend,
329 * {@code false} otherwise
331 public boolean hasFriend(Sone friendSone) {
332 return friendSones.contains(friendSone);
336 * Adds the given Sone as a friend Sone.
339 * The friend Sone to add
340 * @return This Sone (for method chaining)
342 public Sone addFriend(Sone friendSone) {
343 if (!friendSone.equals(this)) {
344 friendSones.add(friendSone);
350 * Removes the given Sone as a friend Sone.
353 * The friend Sone to remove
354 * @return This Sone (for method chaining)
356 public Sone removeFriend(Sone friendSone) {
357 friendSones.remove(friendSone);
362 * Returns the list of posts of this Sone, sorted by time, newest first.
364 * @return All posts of this Sone
366 public List<Post> getPosts() {
367 List<Post> sortedPosts = new ArrayList<Post>(posts);
368 Collections.sort(sortedPosts, new Comparator<Post>() {
371 public int compare(Post leftPost, Post rightPost) {
372 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
380 * Sets all posts of this Sone at once.
383 * The new (and only) posts of this Sone
384 * @return This Sone (for method chaining)
386 public synchronized Sone setPosts(Collection<Post> posts) {
388 this.posts.addAll(posts);
389 modificationCounter++;
394 * Adds the given post to this Sone. The post will not be added if its
395 * {@link Post#getSone() Sone} is not this Sone.
400 public synchronized void addPost(Post post) {
401 if (post.getSone().equals(this) && posts.add(post)) {
402 logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() });
403 modificationCounter++;
408 * Removes the given post from this Sone.
413 public synchronized void removePost(Post post) {
414 if (post.getSone().equals(this) && posts.remove(post)) {
415 modificationCounter++;
420 * Returns all replies this Sone made.
422 * @return All replies this Sone made
424 public Set<Reply> getReplies() {
425 return Collections.unmodifiableSet(replies);
429 * Sets all replies of this Sone at once.
432 * The new (and only) replies of this Sone
433 * @return This Sone (for method chaining)
435 public synchronized Sone setReplies(Collection<Reply> replies) {
436 this.replies.clear();
437 this.replies.addAll(replies);
438 modificationCounter++;
443 * Adds a reply to this Sone. If the given reply was not made by this Sone,
444 * nothing is added to this Sone.
449 public synchronized void addReply(Reply reply) {
450 if (reply.getSone().equals(this) && replies.add(reply)) {
451 modificationCounter++;
456 * Removes a reply from this Sone.
459 * The reply to remove
461 public synchronized void removeReply(Reply reply) {
462 if (reply.getSone().equals(this) && replies.remove(reply)) {
463 modificationCounter++;
468 * Returns the IDs of all liked posts.
470 * @return All liked posts’ IDs
472 public Set<String> getLikedPostIds() {
473 return Collections.unmodifiableSet(likedPostIds);
477 * Sets the IDs of all liked posts.
479 * @param likedPostIds
480 * All liked posts’ IDs
481 * @return This Sone (for method chaining)
483 public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
484 this.likedPostIds.clear();
485 this.likedPostIds.addAll(likedPostIds);
486 modificationCounter++;
491 * Checks whether the given post ID is liked by this Sone.
495 * @return {@code true} if this Sone likes the given post, {@code false}
498 public boolean isLikedPostId(String postId) {
499 return likedPostIds.contains(postId);
503 * Adds the given post ID to the list of posts this Sone likes.
507 * @return This Sone (for method chaining)
509 public synchronized Sone addLikedPostId(String postId) {
510 if (likedPostIds.add(postId)) {
511 modificationCounter++;
517 * Removes the given post ID from the list of posts this Sone likes.
521 * @return This Sone (for method chaining)
523 public synchronized Sone removeLikedPostId(String postId) {
524 if (likedPostIds.remove(postId)) {
525 modificationCounter++;
531 * Returns the IDs of all liked replies.
533 * @return All liked replies’ IDs
535 public Set<String> getLikedReplyIds() {
536 return Collections.unmodifiableSet(likedReplyIds);
540 * Sets the IDs of all liked replies.
542 * @param likedReplyIds
543 * All liked replies’ IDs
544 * @return This Sone (for method chaining)
546 public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
547 this.likedReplyIds.clear();
548 this.likedReplyIds.addAll(likedReplyIds);
549 modificationCounter++;
554 * Checks whether the given reply ID is liked by this Sone.
557 * The ID of the reply
558 * @return {@code true} if this Sone likes the given reply, {@code false}
561 public boolean isLikedReplyId(String replyId) {
562 return likedReplyIds.contains(replyId);
566 * Adds the given reply ID to the list of replies this Sone likes.
569 * The ID of the reply
570 * @return This Sone (for method chaining)
572 public synchronized Sone addLikedReplyId(String replyId) {
573 if (likedReplyIds.add(replyId)) {
574 modificationCounter++;
580 * Removes the given post ID from the list of replies this Sone likes.
583 * The ID of the reply
584 * @return This Sone (for method chaining)
586 public synchronized Sone removeLikedReplyId(String replyId) {
587 if (likedReplyIds.remove(replyId)) {
588 modificationCounter++;
594 * Returns the modification counter.
596 * @return The modification counter
598 public synchronized long getModificationCounter() {
599 return modificationCounter;
603 * Sets the modification counter.
605 * @param modificationCounter
606 * The new modification counter
608 public synchronized void setModificationCounter(long modificationCounter) {
609 this.modificationCounter = modificationCounter;
620 public int hashCode() {
621 return id.hashCode();
628 public boolean equals(Object object) {
629 if (!(object instanceof Sone)) {
632 return ((Sone) object).id.equals(id);
639 public String toString() {
640 return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri=" + insertUri + ",friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";