src/main/java/net/pterodactylus/sone/data/Sone.java

   1 /*
   2  * FreenetSone - Sone.java - Copyright © 2010 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.data;
  19
  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;
  26 import java.util.Set;
  27 import java.util.logging.Level;
  28 import java.util.logging.Logger;
  29
  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;
  34
  35 /**
  36  * A Sone defines everything about a user: her profile, her status updates, her
  37  * replies, her likes and dislikes, etc.
  38  * <p>
  39  * Operations that modify the Sone need to synchronize on the Sone in question.
  40  *
  41  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  42  */
  43 public class Sone {
  44
  45         /** comparator that sorts Sones by their nice name. */
  46         public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
  47
  48                 @Override
  49                 public int compare(Sone leftSone, Sone rightSone) {
  50                         int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
  51                         if (diff != 0) {
  52                                 return diff;
  53                         }
  54                         return leftSone.getId().compareToIgnoreCase(rightSone.getId());
  55                 }
  56
  57         };
  58
  59         /** The logger. */
  60         private static final Logger logger = Logging.getLogger(Sone.class);
  61
  62         /** The ID of this Sone. */
  63         private final String id;
  64
  65         /** The identity of this Sone. */
  66         private Identity identity;
  67
  68         /** The URI under which the Sone is stored in Freenet. */
  69         private volatile FreenetURI requestUri;
  70
  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;
  74
  75         /** The latest edition of the Sone. */
  76         private volatile long latestEdition;
  77
  78         /** The time of the last inserted update. */
  79         private volatile long time;
  80
  81         /** The profile of this Sone. */
  82         private volatile Profile profile;
  83
  84         /** All friend Sones. */
  85         private final Set<Sone> friendSones = Collections.synchronizedSet(new HashSet<Sone>());
  86
  87         /** All posts. */
  88         private final Set<Post> posts = Collections.synchronizedSet(new HashSet<Post>());
  89
  90         /** All replies. */
  91         private final Set<Reply> replies = Collections.synchronizedSet(new HashSet<Reply>());
  92
  93         /** The IDs of all liked posts. */
  94         private final Set<String> likedPostIds = Collections.synchronizedSet(new HashSet<String>());
  95
  96         /** The IDs of all liked replies. */
  97         private final Set<String> likedReplyIds = Collections.synchronizedSet(new HashSet<String>());
  98
  99         /** Modification count. */
 100         private volatile long modificationCounter = 0;
 101
 102         /**
 103          * Creates a new Sone.
 104          *
 105          * @param id
 106          *            The ID of the Sone
 107          */
 108         public Sone(String id) {
 109                 this.id = id;
 110         }
 111
 112         //
 113         // ACCESSORS
 114         //
 115
 116         /**
 117          * Returns the identity of this Sone.
 118          *
 119          * @return The identity of this Sone
 120          */
 121         public String getId() {
 122                 return id;
 123         }
 124
 125         /**
 126          * Returns the identity of this Sone.
 127          *
 128          * @return The identity of this Sone
 129          */
 130         public Identity getIdentity() {
 131                 return identity;
 132         }
 133
 134         /**
 135          * Sets the identity of this Sone. The {@link Identity#getId() ID} of the
 136          * identity has to match this Sone’s {@link #getId()}.
 137          *
 138          * @param identity
 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
 143          */
 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!");
 147                 }
 148                 this.identity = identity;
 149                 return this;
 150         }
 151
 152         /**
 153          * Returns the name of this Sone.
 154          *
 155          * @return The name of this Sone
 156          */
 157         public String getName() {
 158                 return (identity != null) ? identity.getNickname() : null;
 159         }
 160
 161         /**
 162          * Returns the request URI of this Sone.
 163          *
 164          * @return The request URI of this Sone
 165          */
 166         public FreenetURI getRequestUri() {
 167                 return requestUri.setSuggestedEdition(latestEdition);
 168         }
 169
 170         /**
 171          * Sets the request URI of this Sone.
 172          *
 173          * @param requestUri
 174          *            The request URI of this Sone
 175          * @return This Sone (for method chaining)
 176          */
 177         public Sone setRequestUri(FreenetURI requestUri) {
 178                 if (this.requestUri == null) {
 179                         this.requestUri = requestUri.setDocName("Sone").setMetaString(new String[0]);
 180                         return this;
 181                 }
 182                 if (!this.requestUri.equalsKeypair(requestUri)) {
 183                         logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { requestUri, this.requestUri });
 184                         return this;
 185                 }
 186                 return this;
 187         }
 188
 189         /**
 190          * Returns the insert URI of this Sone.
 191          *
 192          * @return The insert URI of this Sone
 193          */
 194         public FreenetURI getInsertUri() {
 195                 return (insertUri != null) ? insertUri.setSuggestedEdition(latestEdition) : null;
 196         }
 197
 198         /**
 199          * Sets the insert URI of this Sone.
 200          *
 201          * @param insertUri
 202          *            The insert URI of this Sone
 203          * @return This Sone (for method chaining)
 204          */
 205         public Sone setInsertUri(FreenetURI insertUri) {
 206                 if (this.insertUri == null) {
 207                         this.insertUri = insertUri.setDocName("Sone").setMetaString(new String[0]);
 208                         return this;
 209                 }
 210                 if (!this.insertUri.equalsKeypair(insertUri)) {
 211                         logger.log(Level.WARNING, "Request URI %s tried to overwrite %s!", new Object[] { insertUri, this.insertUri });
 212                         return this;
 213                 }
 214                 return this;
 215         }
 216
 217         /**
 218          * Returns the latest edition of this Sone.
 219          *
 220          * @return The latest edition of this Sone
 221          */
 222         public long getLatestEdition() {
 223                 return latestEdition;
 224         }
 225
 226         /**
 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
 229          * is not changed.
 230          *
 231          * @param latestEdition
 232          *            The latest edition of this Sone
 233          */
 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 });
 237                         return;
 238                 }
 239                 this.latestEdition = latestEdition;
 240         }
 241
 242         /**
 243          * Return the time of the last inserted update of this Sone.
 244          *
 245          * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
 246          */
 247         public long getTime() {
 248                 return time;
 249         }
 250
 251         /**
 252          * Sets the time of the last inserted update of this Sone.
 253          *
 254          * @param time
 255          *            The time of the update (in milliseconds since Jan 1, 1970 UTC)
 256          * @return This Sone (for method chaining)
 257          */
 258         public Sone setTime(long time) {
 259                 this.time = time;
 260                 return this;
 261         }
 262
 263         /**
 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.
 267          *
 268          * @return A copy of the profile
 269          */
 270         public Profile getProfile() {
 271                 return new Profile(profile);
 272         }
 273
 274         /**
 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
 277          * this Sone!
 278          *
 279          * @param profile
 280          *            The profile to set
 281          */
 282         public synchronized void setProfile(Profile profile) {
 283                 this.profile = new Profile(profile);
 284                 modificationCounter++;
 285         }
 286
 287         /**
 288          * Returns all friend Sones of this Sone.
 289          *
 290          * @return The friend Sones of this Sone
 291          */
 292         public List<Sone> getFriends() {
 293                 List<Sone> friends = new ArrayList<Sone>(friendSones);
 294                 Collections.sort(friends, new Comparator<Sone>() {
 295
 296                         @Override
 297                         public int compare(Sone leftSone, Sone rightSone) {
 298                                 int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
 299                                 if (diff != 0) {
 300                                         return diff;
 301                                 }
 302                                 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightSone.getTime() - leftSone.getTime()));
 303                         }
 304                 });
 305                 return friends;
 306         }
 307
 308         /**
 309          * Sets all friends of this Sone at once.
 310          *
 311          * @param friends
 312          *            The new (and only) friends of this Sone
 313          * @return This Sone (for method chaining)
 314          */
 315         public Sone setFriends(Collection<Sone> friends) {
 316                 friendSones.clear();
 317                 friendSones.addAll(friends);
 318                 return this;
 319         }
 320
 321         /**
 322          * Returns whether this Sone has the given Sone as a friend Sone.
 323          *
 324          * @param friendSone
 325          *            The friend Sone to check for
 326          * @return {@code true} if this Sone has the given Sone as a friend,
 327          *         {@code false} otherwise
 328          */
 329         public boolean hasFriend(Sone friendSone) {
 330                 return friendSones.contains(friendSone);
 331         }
 332
 333         /**
 334          * Adds the given Sone as a friend Sone.
 335          *
 336          * @param friendSone
 337          *            The friend Sone to add
 338          * @return This Sone (for method chaining)
 339          */
 340         public Sone addFriend(Sone friendSone) {
 341                 if (!friendSone.equals(this)) {
 342                         friendSones.add(friendSone);
 343                 }
 344                 return this;
 345         }
 346
 347         /**
 348          * Removes the given Sone as a friend Sone.
 349          *
 350          * @param friendSone
 351          *            The friend Sone to remove
 352          * @return This Sone (for method chaining)
 353          */
 354         public Sone removeFriend(Sone friendSone) {
 355                 friendSones.remove(friendSone);
 356                 return this;
 357         }
 358
 359         /**
 360          * Returns the list of posts of this Sone, sorted by time, newest first.
 361          *
 362          * @return All posts of this Sone
 363          */
 364         public List<Post> getPosts() {
 365                 List<Post> sortedPosts;
 366                 synchronized (this) {
 367                         sortedPosts = new ArrayList<Post>(posts);
 368                 }
 369                 Collections.sort(sortedPosts, Post.TIME_COMPARATOR);
 370                 return sortedPosts;
 371         }
 372
 373         /**
 374          * Sets all posts of this Sone at once.
 375          *
 376          * @param posts
 377          *            The new (and only) posts of this Sone
 378          * @return This Sone (for method chaining)
 379          */
 380         public synchronized Sone setPosts(Collection<Post> posts) {
 381                 this.posts.clear();
 382                 this.posts.addAll(posts);
 383                 modificationCounter++;
 384                 return this;
 385         }
 386
 387         /**
 388          * Adds the given post to this Sone. The post will not be added if its
 389          * {@link Post#getSone() Sone} is not this Sone.
 390          *
 391          * @param post
 392          *            The post to add
 393          */
 394         public synchronized void addPost(Post post) {
 395                 if (post.getSone().equals(this) && posts.add(post)) {
 396                         logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() });
 397                         modificationCounter++;
 398                 }
 399         }
 400
 401         /**
 402          * Removes the given post from this Sone.
 403          *
 404          * @param post
 405          *            The post to remove
 406          */
 407         public synchronized void removePost(Post post) {
 408                 if (post.getSone().equals(this) && posts.remove(post)) {
 409                         modificationCounter++;
 410                 }
 411         }
 412
 413         /**
 414          * Returns all replies this Sone made.
 415          *
 416          * @return All replies this Sone made
 417          */
 418         public Set<Reply> getReplies() {
 419                 return Collections.unmodifiableSet(replies);
 420         }
 421
 422         /**
 423          * Sets all replies of this Sone at once.
 424          *
 425          * @param replies
 426          *            The new (and only) replies of this Sone
 427          * @return This Sone (for method chaining)
 428          */
 429         public synchronized Sone setReplies(Collection<Reply> replies) {
 430                 this.replies.clear();
 431                 this.replies.addAll(replies);
 432                 modificationCounter++;
 433                 return this;
 434         }
 435
 436         /**
 437          * Adds a reply to this Sone. If the given reply was not made by this Sone,
 438          * nothing is added to this Sone.
 439          *
 440          * @param reply
 441          *            The reply to add
 442          */
 443         public synchronized void addReply(Reply reply) {
 444                 if (reply.getSone().equals(this) && replies.add(reply)) {
 445                         modificationCounter++;
 446                 }
 447         }
 448
 449         /**
 450          * Removes a reply from this Sone.
 451          *
 452          * @param reply
 453          *            The reply to remove
 454          */
 455         public synchronized void removeReply(Reply reply) {
 456                 if (reply.getSone().equals(this) && replies.remove(reply)) {
 457                         modificationCounter++;
 458                 }
 459         }
 460
 461         /**
 462          * Returns the IDs of all liked posts.
 463          *
 464          * @return All liked posts’ IDs
 465          */
 466         public Set<String> getLikedPostIds() {
 467                 return Collections.unmodifiableSet(likedPostIds);
 468         }
 469
 470         /**
 471          * Sets the IDs of all liked posts.
 472          *
 473          * @param likedPostIds
 474          *            All liked posts’ IDs
 475          * @return This Sone (for method chaining)
 476          */
 477         public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
 478                 this.likedPostIds.clear();
 479                 this.likedPostIds.addAll(likedPostIds);
 480                 modificationCounter++;
 481                 return this;
 482         }
 483
 484         /**
 485          * Checks whether the given post ID is liked by this Sone.
 486          *
 487          * @param postId
 488          *            The ID of the post
 489          * @return {@code true} if this Sone likes the given post, {@code false}
 490          *         otherwise
 491          */
 492         public boolean isLikedPostId(String postId) {
 493                 return likedPostIds.contains(postId);
 494         }
 495
 496         /**
 497          * Adds the given post ID to the list of posts this Sone likes.
 498          *
 499          * @param postId
 500          *            The ID of the post
 501          * @return This Sone (for method chaining)
 502          */
 503         public synchronized Sone addLikedPostId(String postId) {
 504                 if (likedPostIds.add(postId)) {
 505                         modificationCounter++;
 506                 }
 507                 return this;
 508         }
 509
 510         /**
 511          * Removes the given post ID from the list of posts this Sone likes.
 512          *
 513          * @param postId
 514          *            The ID of the post
 515          * @return This Sone (for method chaining)
 516          */
 517         public synchronized Sone removeLikedPostId(String postId) {
 518                 if (likedPostIds.remove(postId)) {
 519                         modificationCounter++;
 520                 }
 521                 return this;
 522         }
 523
 524         /**
 525          * Returns the IDs of all liked replies.
 526          *
 527          * @return All liked replies’ IDs
 528          */
 529         public Set<String> getLikedReplyIds() {
 530                 return Collections.unmodifiableSet(likedReplyIds);
 531         }
 532
 533         /**
 534          * Sets the IDs of all liked replies.
 535          *
 536          * @param likedReplyIds
 537          *            All liked replies’ IDs
 538          * @return This Sone (for method chaining)
 539          */
 540         public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
 541                 this.likedReplyIds.clear();
 542                 this.likedReplyIds.addAll(likedReplyIds);
 543                 modificationCounter++;
 544                 return this;
 545         }
 546
 547         /**
 548          * Checks whether the given reply ID is liked by this Sone.
 549          *
 550          * @param replyId
 551          *            The ID of the reply
 552          * @return {@code true} if this Sone likes the given reply, {@code false}
 553          *         otherwise
 554          */
 555         public boolean isLikedReplyId(String replyId) {
 556                 return likedReplyIds.contains(replyId);
 557         }
 558
 559         /**
 560          * Adds the given reply ID to the list of replies this Sone likes.
 561          *
 562          * @param replyId
 563          *            The ID of the reply
 564          * @return This Sone (for method chaining)
 565          */
 566         public synchronized Sone addLikedReplyId(String replyId) {
 567                 if (likedReplyIds.add(replyId)) {
 568                         modificationCounter++;
 569                 }
 570                 return this;
 571         }
 572
 573         /**
 574          * Removes the given post ID from the list of replies this Sone likes.
 575          *
 576          * @param replyId
 577          *            The ID of the reply
 578          * @return This Sone (for method chaining)
 579          */
 580         public synchronized Sone removeLikedReplyId(String replyId) {
 581                 if (likedReplyIds.remove(replyId)) {
 582                         modificationCounter++;
 583                 }
 584                 return this;
 585         }
 586
 587         /**
 588          * Returns the modification counter.
 589          *
 590          * @return The modification counter
 591          */
 592         public synchronized long getModificationCounter() {
 593                 return modificationCounter;
 594         }
 595
 596         /**
 597          * Sets the modification counter.
 598          *
 599          * @param modificationCounter
 600          *            The new modification counter
 601          */
 602         public synchronized void setModificationCounter(long modificationCounter) {
 603                 this.modificationCounter = modificationCounter;
 604         }
 605
 606         //
 607         // OBJECT METHODS
 608         //
 609
 610         /**
 611          * {@inheritDoc}
 612          */
 613         @Override
 614         public int hashCode() {
 615                 return id.hashCode();
 616         }
 617
 618         /**
 619          * {@inheritDoc}
 620          */
 621         @Override
 622         public boolean equals(Object object) {
 623                 if (!(object instanceof Sone)) {
 624                         return false;
 625                 }
 626                 return ((Sone) object).id.equals(id);
 627         }
 628
 629         /**
 630          * {@inheritDoc}
 631          */
 632         @Override
 633         public String toString() {
 634                 return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri=" + insertUri + ",friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
 635         }
 636
 637 }