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, NICE_NAME_COMPARATOR);
 295                 return friends;
 296         }
 297
 298         /**
 299          * Sets all friends of this Sone at once.
 300          *
 301          * @param friends
 302          *            The new (and only) friends of this Sone
 303          * @return This Sone (for method chaining)
 304          */
 305         public Sone setFriends(Collection<Sone> friends) {
 306                 friendSones.clear();
 307                 friendSones.addAll(friends);
 308                 return this;
 309         }
 310
 311         /**
 312          * Returns whether this Sone has the given Sone as a friend Sone.
 313          *
 314          * @param friendSone
 315          *            The friend Sone to check for
 316          * @return {@code true} if this Sone has the given Sone as a friend,
 317          *         {@code false} otherwise
 318          */
 319         public boolean hasFriend(Sone friendSone) {
 320                 return friendSones.contains(friendSone);
 321         }
 322
 323         /**
 324          * Adds the given Sone as a friend Sone.
 325          *
 326          * @param friendSone
 327          *            The friend Sone to add
 328          * @return This Sone (for method chaining)
 329          */
 330         public Sone addFriend(Sone friendSone) {
 331                 if (!friendSone.equals(this)) {
 332                         friendSones.add(friendSone);
 333                 }
 334                 return this;
 335         }
 336
 337         /**
 338          * Removes the given Sone as a friend Sone.
 339          *
 340          * @param friendSone
 341          *            The friend Sone to remove
 342          * @return This Sone (for method chaining)
 343          */
 344         public Sone removeFriend(Sone friendSone) {
 345                 friendSones.remove(friendSone);
 346                 return this;
 347         }
 348
 349         /**
 350          * Returns the list of posts of this Sone, sorted by time, newest first.
 351          *
 352          * @return All posts of this Sone
 353          */
 354         public List<Post> getPosts() {
 355                 List<Post> sortedPosts;
 356                 synchronized (this) {
 357                         sortedPosts = new ArrayList<Post>(posts);
 358                 }
 359                 Collections.sort(sortedPosts, Post.TIME_COMPARATOR);
 360                 return sortedPosts;
 361         }
 362
 363         /**
 364          * Sets all posts of this Sone at once.
 365          *
 366          * @param posts
 367          *            The new (and only) posts of this Sone
 368          * @return This Sone (for method chaining)
 369          */
 370         public synchronized Sone setPosts(Collection<Post> posts) {
 371                 this.posts.clear();
 372                 this.posts.addAll(posts);
 373                 modificationCounter++;
 374                 return this;
 375         }
 376
 377         /**
 378          * Adds the given post to this Sone. The post will not be added if its
 379          * {@link Post#getSone() Sone} is not this Sone.
 380          *
 381          * @param post
 382          *            The post to add
 383          */
 384         public synchronized void addPost(Post post) {
 385                 if (post.getSone().equals(this) && posts.add(post)) {
 386                         logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() });
 387                         modificationCounter++;
 388                 }
 389         }
 390
 391         /**
 392          * Removes the given post from this Sone.
 393          *
 394          * @param post
 395          *            The post to remove
 396          */
 397         public synchronized void removePost(Post post) {
 398                 if (post.getSone().equals(this) && posts.remove(post)) {
 399                         modificationCounter++;
 400                 }
 401         }
 402
 403         /**
 404          * Returns all replies this Sone made.
 405          *
 406          * @return All replies this Sone made
 407          */
 408         public synchronized Set<Reply> getReplies() {
 409                 return Collections.unmodifiableSet(replies);
 410         }
 411
 412         /**
 413          * Sets all replies of this Sone at once.
 414          *
 415          * @param replies
 416          *            The new (and only) replies of this Sone
 417          * @return This Sone (for method chaining)
 418          */
 419         public synchronized Sone setReplies(Collection<Reply> replies) {
 420                 this.replies.clear();
 421                 this.replies.addAll(replies);
 422                 modificationCounter++;
 423                 return this;
 424         }
 425
 426         /**
 427          * Adds a reply to this Sone. If the given reply was not made by this Sone,
 428          * nothing is added to this Sone.
 429          *
 430          * @param reply
 431          *            The reply to add
 432          */
 433         public synchronized void addReply(Reply reply) {
 434                 if (reply.getSone().equals(this) && replies.add(reply)) {
 435                         modificationCounter++;
 436                 }
 437         }
 438
 439         /**
 440          * Removes a reply from this Sone.
 441          *
 442          * @param reply
 443          *            The reply to remove
 444          */
 445         public synchronized void removeReply(Reply reply) {
 446                 if (reply.getSone().equals(this) && replies.remove(reply)) {
 447                         modificationCounter++;
 448                 }
 449         }
 450
 451         /**
 452          * Returns the IDs of all liked posts.
 453          *
 454          * @return All liked posts’ IDs
 455          */
 456         public Set<String> getLikedPostIds() {
 457                 return Collections.unmodifiableSet(likedPostIds);
 458         }
 459
 460         /**
 461          * Sets the IDs of all liked posts.
 462          *
 463          * @param likedPostIds
 464          *            All liked posts’ IDs
 465          * @return This Sone (for method chaining)
 466          */
 467         public synchronized Sone setLikePostIds(Set<String> likedPostIds) {
 468                 this.likedPostIds.clear();
 469                 this.likedPostIds.addAll(likedPostIds);
 470                 modificationCounter++;
 471                 return this;
 472         }
 473
 474         /**
 475          * Checks whether the given post ID is liked by this Sone.
 476          *
 477          * @param postId
 478          *            The ID of the post
 479          * @return {@code true} if this Sone likes the given post, {@code false}
 480          *         otherwise
 481          */
 482         public boolean isLikedPostId(String postId) {
 483                 return likedPostIds.contains(postId);
 484         }
 485
 486         /**
 487          * Adds the given post ID to the list of posts this Sone likes.
 488          *
 489          * @param postId
 490          *            The ID of the post
 491          * @return This Sone (for method chaining)
 492          */
 493         public synchronized Sone addLikedPostId(String postId) {
 494                 if (likedPostIds.add(postId)) {
 495                         modificationCounter++;
 496                 }
 497                 return this;
 498         }
 499
 500         /**
 501          * Removes the given post ID from the list of posts this Sone likes.
 502          *
 503          * @param postId
 504          *            The ID of the post
 505          * @return This Sone (for method chaining)
 506          */
 507         public synchronized Sone removeLikedPostId(String postId) {
 508                 if (likedPostIds.remove(postId)) {
 509                         modificationCounter++;
 510                 }
 511                 return this;
 512         }
 513
 514         /**
 515          * Returns the IDs of all liked replies.
 516          *
 517          * @return All liked replies’ IDs
 518          */
 519         public Set<String> getLikedReplyIds() {
 520                 return Collections.unmodifiableSet(likedReplyIds);
 521         }
 522
 523         /**
 524          * Sets the IDs of all liked replies.
 525          *
 526          * @param likedReplyIds
 527          *            All liked replies’ IDs
 528          * @return This Sone (for method chaining)
 529          */
 530         public synchronized Sone setLikeReplyIds(Set<String> likedReplyIds) {
 531                 this.likedReplyIds.clear();
 532                 this.likedReplyIds.addAll(likedReplyIds);
 533                 modificationCounter++;
 534                 return this;
 535         }
 536
 537         /**
 538          * Checks whether the given reply ID is liked by this Sone.
 539          *
 540          * @param replyId
 541          *            The ID of the reply
 542          * @return {@code true} if this Sone likes the given reply, {@code false}
 543          *         otherwise
 544          */
 545         public boolean isLikedReplyId(String replyId) {
 546                 return likedReplyIds.contains(replyId);
 547         }
 548
 549         /**
 550          * Adds the given reply ID to the list of replies this Sone likes.
 551          *
 552          * @param replyId
 553          *            The ID of the reply
 554          * @return This Sone (for method chaining)
 555          */
 556         public synchronized Sone addLikedReplyId(String replyId) {
 557                 if (likedReplyIds.add(replyId)) {
 558                         modificationCounter++;
 559                 }
 560                 return this;
 561         }
 562
 563         /**
 564          * Removes the given post ID from the list of replies this Sone likes.
 565          *
 566          * @param replyId
 567          *            The ID of the reply
 568          * @return This Sone (for method chaining)
 569          */
 570         public synchronized Sone removeLikedReplyId(String replyId) {
 571                 if (likedReplyIds.remove(replyId)) {
 572                         modificationCounter++;
 573                 }
 574                 return this;
 575         }
 576
 577         /**
 578          * Returns the modification counter.
 579          *
 580          * @return The modification counter
 581          */
 582         public synchronized long getModificationCounter() {
 583                 return modificationCounter;
 584         }
 585
 586         /**
 587          * Sets the modification counter.
 588          *
 589          * @param modificationCounter
 590          *            The new modification counter
 591          */
 592         public synchronized void setModificationCounter(long modificationCounter) {
 593                 this.modificationCounter = modificationCounter;
 594         }
 595
 596         //
 597         // OBJECT METHODS
 598         //
 599
 600         /**
 601          * {@inheritDoc}
 602          */
 603         @Override
 604         public int hashCode() {
 605                 return id.hashCode();
 606         }
 607
 608         /**
 609          * {@inheritDoc}
 610          */
 611         @Override
 612         public boolean equals(Object object) {
 613                 if (!(object instanceof Sone)) {
 614                         return false;
 615                 }
 616                 return ((Sone) object).id.equals(id);
 617         }
 618
 619         /**
 620          * {@inheritDoc}
 621          */
 622         @Override
 623         public String toString() {
 624                 return getClass().getName() + "[identity=" + identity + ",requestUri=" + requestUri + ",insertUri(" + String.valueOf(insertUri).length() + "),friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
 625         }
 626
 627 }