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 = new Profile();
84 /** The client used by the Sone. */
85 private volatile Client client;
87 /** All friend Sones. */
88 private final Set<String> friendSones = Collections.synchronizedSet(new HashSet<String>());
91 private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
94 private final Set<Reply> replies = Collections.synchronizedSet(new HashSet<Reply>());
96 /** The IDs of all liked posts. */
97 private final Set<String> likedPostIds = Collections.synchronizedSet(new HashSet<String>());
99 /** The IDs of all liked replies. */
100 private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
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 != null) ? requestUri.setSuggestedEdition(latestEdition) : null;
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 });
190 * Returns the insert URI of this Sone.
192 * @return The insert URI of this Sone
194 public FreenetURI getInsertUri() {
195 return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null;
199 * Sets the insert URI of this Sone.
202 * The insert URI of this Sone
203 * @return This Sone (for method chaining)
205 public Sone setInsertUri(FreenetURI insertUri) {
206 if (this.insertUri == null) {
207 this.insertUri = insertUri.setDocName("Sone").setMetaString(new String[0]);
210 if (!this.insertUri.equalsKeypair(insertUri)) {
211 logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { insertUri, this.insertUri });
218 * Returns the latest edition of this Sone.
220 * @return The latest edition of this Sone
222 public long getLatestEdition() {
223 return latestEdition;
227 * Sets the latest edition of this Sone. If the given latest edition is not
228 * greater than the current latest edition, the latest edition of this Sone
231 * @param latestEdition
232 * The latest edition of this Sone
234 public void setLatestEdition(long latestEdition) {
235 if (!(latestEdition > this.latestEdition)) {
236 logger.log(Level.INFO, "New latest edition %d is not greater than current latest edition %d!", new Object[] { latestEdition, this.latestEdition });
239 this.latestEdition = latestEdition;
243 * Return the time of the last inserted update of this Sone.
245 * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
247 public long getTime() {
252 * Sets the time of the last inserted update of this Sone.
255 * The time of the update (in milliseconds since Jan 1, 1970 UTC)
256 * @return This Sone (for method chaining)
258 public Sone setTime(long time) {
264 * Returns a copy of the profile. If you want to update values in the
265 * profile of this Sone, update the values in the returned {@link Profile}
266 * and use {@link #setProfile(Profile)} to change the profile in this Sone.
268 * @return A copy of the profile
270 public synchronized Profile getProfile() {
271 return new Profile(profile);
275 * Sets the profile of this Sone. A copy of the given profile is stored so
276 * that subsequent modifications of the given profile are not reflected in
282 public synchronized void setProfile(Profile profile) {
283 this.profile = new Profile(profile);
287 * Returns the client used by this Sone.
289 * @return The client used by this Sone, or {@code null}
291 public Client getClient() {
296 * Sets the client used by this Sone.
299 * The client used by this Sone, or {@code null}
300 * @return This Sone (for method chaining)
302 public Sone setClient(Client client) {
303 this.client = client;
308 * Returns all friend Sones of this Sone.
310 * @return The friend Sones of this Sone
312 public List<String> getFriends() {
313 List<String> friends = new ArrayList<String>(friendSones);
318 * Sets all friends of this Sone at once.
321 * The new (and only) friends of this Sone
322 * @return This Sone (for method chaining)
324 public Sone setFriends(Collection<String> friends) {
326 friendSones.addAll(friends);
331 * Returns whether this Sone has the given Sone as a friend Sone.
333 * @param friendSoneId
334 * The ID of the Sone to check for
335 * @return {@code true} if this Sone has the given Sone as a friend,
336 * {@code false} otherwise
338 public boolean hasFriend(String friendSoneId) {
339 return friendSones.contains(friendSoneId);
343 * Adds the given Sone as a friend Sone.
346 * The friend Sone to add
347 * @return This Sone (for method chaining)
349 public Sone addFriend(String friendSone) {
350 if (!friendSone.equals(id)) {
351 friendSones.add(friendSone);
357 * Removes the given Sone as a friend Sone.
359 * @param friendSoneId
360 * The ID of the friend Sone to remove
361 * @return This Sone (for method chaining)
363 public Sone removeFriend(String friendSoneId) {
364 friendSones.remove(friendSoneId);
369 * Returns the list of posts of this Sone, sorted by time, newest first.
371 * @return All posts of this Sone
373 public List<Post> getPosts() {
374 List<Post> sortedPosts;
375 synchronized (this) {
376 sortedPosts = new ArrayList<Post>(posts);
378 Collections.sort(sortedPosts, Post.TIME_COMPARATOR);
383 * Sets all posts of this Sone at once.
386 * The new (and only) posts of this Sone
387 * @return This Sone (for method chaining)
389 public synchronized Sone setPosts(Collection<Post> posts) {
391 this.posts.addAll(posts);
396 * Adds the given post to this Sone. The post will not be added if its
397 * {@link Post#getSone() Sone} is not this Sone.
402 public synchronized void addPost(Post post) {
403 if (post.getSone().equals(this) && posts.add(post)) {
404 logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() });
409 * Removes the given post from this Sone.
414 public synchronized void removePost(Post post) {
415 if (post.getSone().equals(this)) {
421 * Returns all replies this Sone made.
423 * @return All replies this Sone made
425 public synchronized Set<Reply> getReplies() {
426 return Collections.unmodifiableSet(replies);
430 * Sets all replies of this Sone at once.
433 * The new (and only) replies of this Sone
434 * @return This Sone (for method chaining)
436 public synchronized Sone setReplies(Collection<Reply> replies) {
437 this.replies.clear();
438 this.replies.addAll(replies);
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)) {
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)) {
463 replies.remove(reply);
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);
490 * Checks whether the given post ID is liked by this Sone.
494 * @return {@code true} if this Sone likes the given post, {@code false}
497 public boolean isLikedPostId(String postId) {
498 return likedPostIds.contains(postId);
502 * Adds the given post ID to the list of posts this Sone likes.
506 * @return This Sone (for method chaining)
508 public synchronized Sone addLikedPostId(String postId) {
509 likedPostIds.add(postId);
514 * Removes the given post ID from the list of posts this Sone likes.
518 * @return This Sone (for method chaining)
520 public synchronized Sone removeLikedPostId(String postId) {
521 likedPostIds.remove(postId);
526 * Returns the IDs of all liked replies.
528 * @return All liked replies’ IDs
530 public Set<String> getLikedReplyIds() {
531 return Collections.unmodifiableSet(likedReplyIds);
535 * Sets the IDs of all liked replies.
537 * @param likedReplyIds
538 * All liked replies’ IDs
539 * @return This Sone (for method chaining)
541 public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
542 this.likedReplyIds.clear();
543 this.likedReplyIds.addAll(likedReplyIds);
548 * Checks whether the given reply ID is liked by this Sone.
551 * The ID of the reply
552 * @return {@code true} if this Sone likes the given reply, {@code false}
555 public boolean isLikedReplyId(String replyId) {
556 return likedReplyIds.contains(replyId);
560 * Adds the given reply ID to the list of replies this Sone likes.
563 * The ID of the reply
564 * @return This Sone (for method chaining)
566 public synchronized Sone addLikedReplyId(String replyId) {
567 likedReplyIds.add(replyId);
572 * Removes the given post ID from the list of replies this Sone likes.
575 * The ID of the reply
576 * @return This Sone (for method chaining)
578 public synchronized Sone removeLikedReplyId(String replyId) {
579 likedReplyIds.remove(replyId);
584 * Returns a fingerprint of this Sone. The fingerprint only depends on data
585 * that is actually stored when a Sone is inserted. The fingerprint can be
586 * used to detect changes in Sone data and can also be used to detect if
587 * previous changes are reverted.
589 * @return The fingerprint of this Sone
591 public synchronized String getFingerprint() {
592 StringBuilder fingerprint = new StringBuilder();
593 fingerprint.append("Profile(");
594 if (profile.getFirstName() != null) {
595 fingerprint.append("FirstName(").append(profile.getFirstName()).append(')');
597 if (profile.getMiddleName() != null) {
598 fingerprint.append("MiddleName(").append(profile.getMiddleName()).append(')');
600 if (profile.getLastName() != null) {
601 fingerprint.append("LastName(").append(profile.getLastName()).append(')');
603 if (profile.getBirthDay() != null) {
604 fingerprint.append("BirthDay(").append(profile.getBirthDay()).append(')');
606 if (profile.getBirthMonth() != null) {
607 fingerprint.append("BirthMonth(").append(profile.getBirthMonth()).append(')');
609 if (profile.getBirthYear() != null) {
610 fingerprint.append("BirthYear(").append(profile.getBirthYear()).append(')');
612 fingerprint.append(")");
614 fingerprint.append("Posts(");
615 for (Post post : getPosts()) {
616 fingerprint.append("Post(").append(post.getId()).append(')');
618 fingerprint.append(")");
620 List<Reply> replies = new ArrayList<Reply>(getReplies());
621 Collections.sort(replies, Reply.TIME_COMPARATOR);
622 fingerprint.append("Replies(");
623 for (Reply reply : replies) {
624 fingerprint.append("Reply(").append(reply.getId()).append(')');
626 fingerprint.append(')');
628 List<String> likedPostIds = new ArrayList<String>(getLikedPostIds());
629 Collections.sort(likedPostIds);
630 fingerprint.append("LikedPosts(");
631 for (String likedPostId : likedPostIds) {
632 fingerprint.append("Post(").append(likedPostId).append(')');
634 fingerprint.append(')');
636 List<String> likedReplyIds = new ArrayList<String>(getLikedReplyIds());
637 Collections.sort(likedReplyIds);
638 fingerprint.append("LikedReplies(");
639 for (String likedReplyId : likedReplyIds) {
640 fingerprint.append("Reply(").append(likedReplyId).append(')');
642 fingerprint.append(')');
644 return fingerprint.toString();
655 public int hashCode() {
656 return id.hashCode();
663 public boolean equals(Object object) {
664 if (!(object instanceof Sone)) {
667 return ((Sone) object).id.equals(id);
674 public String toString() {
675 return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri(" + String.valueOf(insertUri).length() + "),friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";