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.UUID;
  28 import java.util.logging.Level;
  29 import java.util.logging.Logger;
  30
  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         /** The logger. */
  46         private static final Logger logger = Logging.getLogger(Sone.class);
  47
  48         /** A GUID for this Sone. */
  49         private final UUID id;
  50
  51         /** The name of this Sone. */
  52         private String name;
  53
  54         /** The URI under which the Sone is stored in Freenet. */
  55         private FreenetURI requestUri;
  56
  57         /** The URI used to insert a new version of this Sone. */
  58         /* This will be null for remote Sones! */
  59         private FreenetURI insertUri;
  60
  61         /** The time of the last inserted update. */
  62         private long time;
  63
  64         /** The profile of this Sone. */
  65         private Profile profile;
  66
  67         /** All friend Sones. */
  68         private final Set<Sone> friendSones = new HashSet<Sone>();
  69
  70         /** All posts. */
  71         private final Set<Post> posts = new HashSet<Post>();
  72
  73         /** All replies. */
  74         private final Set<Reply> replies = new HashSet<Reply>();
  75
  76         /** The IDs of all blocked Sones. */
  77         private final Set<String> blockedSoneIds = new HashSet<String>();
  78
  79         /** Modification count. */
  80         private volatile long modificationCounter = 0;
  81
  82         /**
  83          * Creates a new Sone.
  84          *
  85          * @param id
  86          *            The ID of this Sone
  87          */
  88         public Sone(String id) {
  89                 this.id = UUID.fromString(id);
  90         }
  91
  92         //
  93         // ACCESSORS
  94         //
  95
  96         /**
  97          * Returns the ID of this Sone.
  98          *
  99          * @return The ID of this Sone
 100          */
 101         public String getId() {
 102                 return id.toString();
 103         }
 104
 105         /**
 106          * Returns the name of this Sone.
 107          *
 108          * @return The name of this Sone
 109          */
 110         public String getName() {
 111                 return name;
 112         }
 113
 114         /**
 115          * Sets the name of this Sone.
 116          *
 117          * @param name
 118          *            The name of this Sone
 119          * @return This sone (for method chaining)
 120          */
 121         public Sone setName(String name) {
 122                 this.name = name;
 123                 return this;
 124         }
 125
 126         /**
 127          * Returns the request URI of this Sone.
 128          *
 129          * @return The request URI of this Sone
 130          */
 131         public FreenetURI getRequestUri() {
 132                 return requestUri;
 133         }
 134
 135         /**
 136          * Sets the request URI of this Sone.
 137          *
 138          * @param requestUri
 139          *            The request URI of this Sone
 140          * @return This Sone (for method chaining)
 141          */
 142         public Sone setRequestUri(FreenetURI requestUri) {
 143                 this.requestUri = requestUri;
 144                 return this;
 145         }
 146
 147         /**
 148          * Returns the insert URI of this Sone.
 149          *
 150          * @return The insert URI of this Sone
 151          */
 152         public FreenetURI getInsertUri() {
 153                 return insertUri;
 154         }
 155
 156         /**
 157          * Sets the insert URI of this Sone.
 158          *
 159          * @param insertUri
 160          *            The insert URI of this Sone
 161          * @return This Sone (for method chaining)
 162          */
 163         public Sone setInsertUri(FreenetURI insertUri) {
 164                 this.insertUri = insertUri;
 165                 return this;
 166         }
 167
 168         /**
 169          * Return the time of the last inserted update of this Sone.
 170          *
 171          * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
 172          */
 173         public long getTime() {
 174                 return time;
 175         }
 176
 177         /**
 178          * Sets the time of the last inserted update of this Sone.
 179          *
 180          * @param time
 181          *            The time of the update (in milliseconds since Jan 1, 1970 UTC)
 182          * @return This Sone (for method chaining)
 183          */
 184         public Sone setTime(long time) {
 185                 this.time = time;
 186                 return this;
 187         }
 188
 189         /**
 190          * Returns a copy of the profile. If you want to update values in the
 191          * profile of this Sone, update the values in the returned {@link Profile}
 192          * and use {@link #setProfile(Profile)} to change the profile in this Sone.
 193          *
 194          * @return A copy of the profile
 195          */
 196         public Profile getProfile() {
 197                 return new Profile(profile);
 198         }
 199
 200         /**
 201          * Sets the profile of this Sone. A copy of the given profile is stored so
 202          * that subsequent modifications of the given profile are not reflected in
 203          * this Sone!
 204          *
 205          * @param profile
 206          *            The profile to set
 207          */
 208         public synchronized void setProfile(Profile profile) {
 209                 this.profile = new Profile(profile);
 210                 modificationCounter++;
 211         }
 212
 213         /**
 214          * Returns all friend Sones of this Sone.
 215          *
 216          * @return The friend Sones of this Sone
 217          */
 218         public List<Sone> getFriends() {
 219                 List<Sone> friends = new ArrayList<Sone>(friendSones);
 220                 Collections.sort(friends, new Comparator<Sone>() {
 221
 222                         @Override
 223                         public int compare(Sone leftSone, Sone rightSone) {
 224                                 int diff = SoneAccessor.getNiceName(leftSone).compareTo(SoneAccessor.getNiceName(rightSone));
 225                                 if (diff != 0) {
 226                                         return diff;
 227                                 }
 228                                 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightSone.getTime() - leftSone.getTime()));
 229                         }
 230                 });
 231                 return friends;
 232         }
 233
 234         /**
 235          * Sets all friends of this Sone at once.
 236          *
 237          * @param friends
 238          *            The new (and only) friends of this Sone
 239          * @return This Sone (for method chaining)
 240          */
 241         public synchronized Sone setFriends(Collection<Sone> friends) {
 242                 friendSones.clear();
 243                 friendSones.addAll(friends);
 244                 modificationCounter++;
 245                 return this;
 246         }
 247
 248         /**
 249          * Returns whether this Sone has the given Sone as a friend Sone.
 250          *
 251          * @param friendSone
 252          *            The friend Sone to check for
 253          * @return {@code true} if this Sone has the given Sone as a friend,
 254          *         {@code false} otherwise
 255          */
 256         public boolean hasFriend(Sone friendSone) {
 257                 return friendSones.contains(friendSone);
 258         }
 259
 260         /**
 261          * Adds the given Sone as a friend Sone.
 262          *
 263          * @param friendSone
 264          *            The friend Sone to add
 265          * @return This Sone (for method chaining)
 266          */
 267         public synchronized Sone addFriend(Sone friendSone) {
 268                 if (!friendSone.equals(this) && friendSones.add(friendSone)) {
 269                         modificationCounter++;
 270                 }
 271                 return this;
 272         }
 273
 274         /**
 275          * Removes the given Sone as a friend Sone.
 276          *
 277          * @param friendSone
 278          *            The friend Sone to remove
 279          * @return This Sone (for method chaining)
 280          */
 281         public synchronized Sone removeFriend(Sone friendSone) {
 282                 if (friendSones.remove(friendSone)) {
 283                         modificationCounter++;
 284                 }
 285                 return this;
 286         }
 287
 288         /**
 289          * Returns the list of posts of this Sone, sorted by time, newest first.
 290          *
 291          * @return All posts of this Sone
 292          */
 293         public List<Post> getPosts() {
 294                 List<Post> sortedPosts = new ArrayList<Post>(posts);
 295                 Collections.sort(sortedPosts, new Comparator<Post>() {
 296
 297                         @Override
 298                         public int compare(Post leftPost, Post rightPost) {
 299                                 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, rightPost.getTime() - leftPost.getTime()));
 300                         }
 301
 302                 });
 303                 return sortedPosts;
 304         }
 305
 306         /**
 307          * Sets all posts of this Sone at once.
 308          *
 309          * @param posts
 310          *            The new (and only) posts of this Sone
 311          * @return This Sone (for method chaining)
 312          */
 313         public synchronized Sone setPosts(Collection<Post> posts) {
 314                 this.posts.clear();
 315                 this.posts.addAll(posts);
 316                 modificationCounter++;
 317                 return this;
 318         }
 319
 320         /**
 321          * Adds the given post to this Sone. The post will not be added if its
 322          * {@link Post#getSone() Sone} is not this Sone.
 323          *
 324          * @param post
 325          *            The post to add
 326          */
 327         public synchronized void addPost(Post post) {
 328                 if (post.getSone().equals(this) && posts.add(post)) {
 329                         logger.log(Level.FINEST, "Adding %s to “%s”.", new Object[] { post, getName() });
 330                         modificationCounter++;
 331                 }
 332         }
 333
 334         /**
 335          * Removes the given post from this Sone.
 336          *
 337          * @param post
 338          *            The post to remove
 339          */
 340         public synchronized void removePost(Post post) {
 341                 if (post.getSone().equals(this) && posts.remove(post)) {
 342                         modificationCounter++;
 343                 }
 344         }
 345
 346         /**
 347          * Returns all replies this Sone made.
 348          *
 349          * @return All replies this Sone made
 350          */
 351         public Set<Reply> getReplies() {
 352                 logger.log(Level.FINEST, "Friends of %s: %s", new Object[] { this, friendSones });
 353                 return Collections.unmodifiableSet(replies);
 354         }
 355
 356         /**
 357          * Sets all replies of this Sone at once.
 358          *
 359          * @param replies
 360          *            The new (and only) replies of this Sone
 361          * @return This Sone (for method chaining)
 362          */
 363         public synchronized Sone setReplies(Collection<Reply> replies) {
 364                 this.replies.clear();
 365                 this.replies.addAll(replies);
 366                 modificationCounter++;
 367                 return this;
 368         }
 369
 370         /**
 371          * Adds a reply to this Sone. If the given reply was not made by this Sone,
 372          * nothing is added to this Sone.
 373          *
 374          * @param reply
 375          *            The reply to add
 376          */
 377         public synchronized void addReply(Reply reply) {
 378                 if (reply.getSone().equals(this) && replies.add(reply)) {
 379                         modificationCounter++;
 380                 }
 381         }
 382
 383         /**
 384          * Removes a reply from this Sone.
 385          *
 386          * @param reply
 387          *            The reply to remove
 388          */
 389         public synchronized void removeReply(Reply reply) {
 390                 if (reply.getSone().equals(this) && replies.remove(reply)) {
 391                         modificationCounter++;
 392                 }
 393         }
 394
 395         /**
 396          * Returns the IDs of all blocked Sones. These Sones will not propagated
 397          * using the “known Sones” mechanism.
 398          *
 399          * @return The IDs of all blocked Sones
 400          */
 401         public Set<String> getBlockedSoneIds() {
 402                 return Collections.unmodifiableSet(blockedSoneIds);
 403         }
 404
 405         /**
 406          * Returns whether the given Sone ID is blocked.
 407          *
 408          * @param soneId
 409          *            The Sone ID to check
 410          * @return {@code true} if the given Sone ID is blocked, {@code false}
 411          *         otherwise
 412          */
 413         public boolean isSoneBlocked(String soneId) {
 414                 return blockedSoneIds.contains(soneId);
 415         }
 416
 417         /**
 418          * Adds the given ID to the list of blocked IDs.
 419          *
 420          * @param soneId
 421          *            The Sone ID to block
 422          */
 423         public synchronized void addBlockedSoneId(String soneId) {
 424                 if (blockedSoneIds.add(soneId)) {
 425                         modificationCounter++;
 426                 }
 427         }
 428
 429         /**
 430          * Removes the given ID from the list of blocked IDs.
 431          *
 432          * @param soneId
 433          *            The Sone ID to unblock
 434          */
 435         public synchronized void removeBlockedSoneId(String soneId) {
 436                 if (blockedSoneIds.remove(soneId)) {
 437                         modificationCounter++;
 438                 }
 439         }
 440
 441         /**
 442          * Returns the modification counter.
 443          *
 444          * @return The modification counter
 445          */
 446         public synchronized long getModificationCounter() {
 447                 return modificationCounter;
 448         }
 449
 450         /**
 451          * Sets the modification counter.
 452          *
 453          * @param modificationCounter
 454          *            The new modification counter
 455          */
 456         public synchronized void setModificationCounter(long modificationCounter) {
 457                 this.modificationCounter = modificationCounter;
 458         }
 459
 460         /**
 461          * Updates the suggested edition in both the request URI and the insert URI.
 462          *
 463          * @param requestUri
 464          *            The request URI that resulted from an insert
 465          */
 466         public void updateUris(FreenetURI requestUri) {
 467                 /* TODO - check for the correct URI. */
 468                 long latestEdition = requestUri.getSuggestedEdition();
 469                 this.requestUri = this.requestUri.setSuggestedEdition(latestEdition);
 470                 if (this.insertUri != null) {
 471                         this.insertUri = this.insertUri.setSuggestedEdition(latestEdition);
 472                 }
 473         }
 474
 475         //
 476         // OBJECT METHODS
 477         //
 478
 479         /**
 480          * {@inheritDoc}
 481          */
 482         @Override
 483         public int hashCode() {
 484                 return id.hashCode();
 485         }
 486
 487         /**
 488          * {@inheritDoc}
 489          */
 490         @Override
 491         public boolean equals(Object object) {
 492                 if (!(object instanceof Sone)) {
 493                         return false;
 494                 }
 495                 return ((Sone) object).id.equals(id);
 496         }
 497
 498         /**
 499          * {@inheritDoc}
 500          */
 501         @Override
 502         public String toString() {
 503                 return getClass().getName() + "[id=" + id + ",name=" + name + ",requestUri=" + requestUri + ",insertUri=" + insertUri + ",friends(" + friendSones.size() + "),posts(" + posts.size() + "),replies(" + replies.size() + ")]";
 504         }
 505
 506 }