src/main/java/net/pterodactylus/sone/data/impl/SoneImpl.java

   1 /*
   2  * Sone - SoneImpl.java - Copyright © 2010–2013 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.impl;
  19
  20 import static com.google.common.base.Preconditions.checkNotNull;
  21 import static java.lang.String.format;
  22 import static java.util.logging.Logger.getLogger;
  23
  24 import java.net.MalformedURLException;
  25 import java.util.ArrayList;
  26 import java.util.Collection;
  27 import java.util.Collections;
  28 import java.util.HashSet;
  29 import java.util.List;
  30 import java.util.Set;
  31 import java.util.concurrent.CopyOnWriteArraySet;
  32 import java.util.logging.Level;
  33 import java.util.logging.Logger;
  34
  35 import net.pterodactylus.sone.data.Album;
  36 import net.pterodactylus.sone.data.Client;
  37 import net.pterodactylus.sone.data.LocalSone;
  38 import net.pterodactylus.sone.data.Post;
  39 import net.pterodactylus.sone.data.PostReply;
  40 import net.pterodactylus.sone.data.Profile;
  41 import net.pterodactylus.sone.data.Reply;
  42 import net.pterodactylus.sone.data.Sone;
  43 import net.pterodactylus.sone.data.SoneOptions;
  44 import net.pterodactylus.sone.data.SoneOptions.DefaultSoneOptions;
  45 import net.pterodactylus.sone.database.Database;
  46 import net.pterodactylus.sone.freenet.wot.Identity;
  47 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  48
  49 import freenet.keys.FreenetURI;
  50
  51 import com.google.common.collect.FluentIterable;
  52 import com.google.common.hash.Hasher;
  53 import com.google.common.hash.Hashing;
  54
  55 /**
  56  * {@link Sone} implementation.
  57  * <p/>
  58  * Operations that modify the Sone need to synchronize on the Sone in question.
  59  *
  60  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  61  */
  62 public class SoneImpl implements LocalSone {
  63
  64         /** The logger. */
  65         private static final Logger logger = getLogger("Sone.Data");
  66
  67         /** The database. */
  68         private final Database database;
  69
  70         /** The ID of this Sone. */
  71         private final String id;
  72
  73         /** Whether the Sone is local. */
  74         private final boolean local;
  75
  76         /** The identity of this Sone. */
  77         private final Identity identity;
  78
  79         /** The latest edition of the Sone. */
  80         private volatile long latestEdition;
  81
  82         /** The time of the last inserted update. */
  83         private final long time;
  84
  85         /** The status of this Sone. */
  86         private volatile SoneStatus status = SoneStatus.unknown;
  87
  88         /** The profile of this Sone. */
  89         private volatile Profile profile = new Profile(this);
  90
  91         /** The client used by the Sone. */
  92         private final Client client;
  93
  94         /** Whether this Sone is known. */
  95         private volatile boolean known;
  96
  97         /** All posts. */
  98         private final Collection<Post> posts = new HashSet<Post>();
  99
 100         /** All replies. */
 101         private final Set<PostReply> replies = new CopyOnWriteArraySet<PostReply>();
 102
 103         /** The IDs of all liked posts. */
 104         private final Set<String> likedPostIds = new CopyOnWriteArraySet<String>();
 105
 106         /** The IDs of all liked replies. */
 107         private final Set<String> likedReplyIds = new CopyOnWriteArraySet<String>();
 108
 109         /** The root album containing all albums. */
 110         private final Album rootAlbum = new AlbumImpl(this);
 111
 112         /** Sone-specific options. */
 113         private SoneOptions options = new DefaultSoneOptions();
 114
 115         /**
 116          * Creates a new Sone.
 117          *
 118          * @param database The database
 119          * @param identity
 120          *              The identity of the Sone
 121          * @param local
 122          *              {@code true} if the Sone is a local Sone, {@code false} otherwise
 123          */
 124         public SoneImpl(Database database, Identity identity, boolean local, long time, Client client, Collection<Post> posts) {
 125                 this.database = database;
 126                 this.id = identity.getId();
 127                 this.identity = identity;
 128                 this.local = local;
 129                 this.time = time;
 130                 this.client = client;
 131                 this.posts.addAll(posts);
 132         }
 133
 134         //
 135         // ACCESSORS
 136         //
 137
 138         /**
 139          * Returns the identity of this Sone.
 140          *
 141          * @return The identity of this Sone
 142          */
 143         public String getId() {
 144                 return id;
 145         }
 146
 147         /**
 148          * Returns the identity of this Sone.
 149          *
 150          * @return The identity of this Sone
 151          */
 152         public Identity getIdentity() {
 153                 return identity;
 154         }
 155
 156         /**
 157          * Returns the name of this Sone.
 158          *
 159          * @return The name of this Sone
 160          */
 161         public String getName() {
 162                 return (identity != null) ? identity.getNickname() : null;
 163         }
 164
 165         /**
 166          * Returns whether this Sone is a local Sone.
 167          *
 168          * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
 169          */
 170         public boolean isLocal() {
 171                 return local;
 172         }
 173
 174         /**
 175          * Returns the request URI of this Sone.
 176          *
 177          * @return The request URI of this Sone
 178          */
 179         public FreenetURI getRequestUri() {
 180                 try {
 181                         return new FreenetURI(getIdentity().getRequestUri())
 182                                         .setKeyType("USK")
 183                                         .setDocName("Sone")
 184                                         .setMetaString(new String[0])
 185                                         .setSuggestedEdition(latestEdition);
 186                 } catch (MalformedURLException e) {
 187                         throw new IllegalStateException(
 188                                         format("Identity %s's request URI is incorrect.",
 189                                                         getIdentity()), e);
 190                 }
 191         }
 192
 193         /**
 194          * Returns the insert URI of this Sone.
 195          *
 196          * @return The insert URI of this Sone
 197          */
 198         public FreenetURI getInsertUri() {
 199                 if (!isLocal()) {
 200                         return null;
 201                 }
 202                 try {
 203                         return new FreenetURI(((OwnIdentity) getIdentity()).getInsertUri())
 204                                         .setDocName("Sone")
 205                                         .setMetaString(new String[0])
 206                                         .setSuggestedEdition(latestEdition);
 207                 } catch (MalformedURLException e) {
 208                         throw new IllegalStateException(format("Own identity %s's insert URI is incorrect.", getIdentity()), e);
 209                 }
 210         }
 211
 212         /**
 213          * Returns the latest edition of this Sone.
 214          *
 215          * @return The latest edition of this Sone
 216          */
 217         public long getLatestEdition() {
 218                 return latestEdition;
 219         }
 220
 221         /**
 222          * Sets the latest edition of this Sone. If the given latest edition is not
 223          * greater than the current latest edition, the latest edition of this Sone is
 224          * not changed.
 225          *
 226          * @param latestEdition
 227          *              The latest edition of this Sone
 228          */
 229         public void setLatestEdition(long latestEdition) {
 230                 if (!(latestEdition > this.latestEdition)) {
 231                         logger.log(Level.FINE, String.format("New latest edition %d is not greater than current latest edition %d!", latestEdition, this.latestEdition));
 232                         return;
 233                 }
 234                 this.latestEdition = latestEdition;
 235         }
 236
 237         /**
 238          * Return the time of the last inserted update of this Sone.
 239          *
 240          * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
 241          */
 242         public long getTime() {
 243                 return time;
 244         }
 245
 246         /**
 247          * Returns the status of this Sone.
 248          *
 249          * @return The status of this Sone
 250          */
 251         public SoneStatus getStatus() {
 252                 return status;
 253         }
 254
 255         /**
 256          * Sets the new status of this Sone.
 257          *
 258          * @param status
 259          *              The new status of this Sone
 260          * @return This Sone
 261          * @throws IllegalArgumentException
 262          *              if {@code status} is {@code null}
 263          */
 264         public Sone setStatus(SoneStatus status) {
 265                 this.status = checkNotNull(status, "status must not be null");
 266                 return this;
 267         }
 268
 269         /**
 270          * Returns a copy of the profile. If you want to update values in the profile
 271          * of this Sone, update the values in the returned {@link Profile} and use
 272          * {@link #setProfile(Profile)} to change the profile in this Sone.
 273          *
 274          * @return A copy of the profile
 275          */
 276         public Profile getProfile() {
 277                 return new Profile(profile);
 278         }
 279
 280         /**
 281          * Sets the profile of this Sone. A copy of the given profile is stored so that
 282          * subsequent modifications of the given profile are not reflected in this
 283          * Sone!
 284          *
 285          * @param profile
 286          *              The profile to set
 287          */
 288         public void setProfile(Profile profile) {
 289                 this.profile = new Profile(profile);
 290         }
 291
 292         /**
 293          * Returns the client used by this Sone.
 294          *
 295          * @return The client used by this Sone, or {@code null}
 296          */
 297         public Client getClient() {
 298                 return client;
 299         }
 300
 301         /**
 302          * Sets the client used by this Sone.
 303          *
 304          * @param client
 305          *              The client used by this Sone, or {@code null}
 306          * @return This Sone (for method chaining)
 307          */
 308         public Sone setClient(Client client) {
 309                 return this;
 310         }
 311
 312         /**
 313          * Returns whether this Sone is known.
 314          *
 315          * @return {@code true} if this Sone is known, {@code false} otherwise
 316          */
 317         public boolean isKnown() {
 318                 return known;
 319         }
 320
 321         /**
 322          * Sets whether this Sone is known.
 323          *
 324          * @param known
 325          *              {@code true} if this Sone is known, {@code false} otherwise
 326          * @return This Sone
 327          */
 328         public Sone setKnown(boolean known) {
 329                 this.known = known;
 330                 return this;
 331         }
 332
 333         /**
 334          * Returns all friend Sones of this Sone.
 335          *
 336          * @return The friend Sones of this Sone
 337          */
 338         public Collection<String> getFriends() {
 339                 return database.getFriends(this);
 340         }
 341
 342         /**
 343          * Returns whether this Sone has the given Sone as a friend Sone.
 344          *
 345          * @param friendSoneId
 346          *              The ID of the Sone to check for
 347          * @return {@code true} if this Sone has the given Sone as a friend, {@code
 348          *         false} otherwise
 349          */
 350         public boolean hasFriend(String friendSoneId) {
 351                 return database.isFriend(this, friendSoneId);
 352         }
 353
 354         /**
 355          * Returns the list of posts of this Sone, sorted by time, newest first.
 356          *
 357          * @return All posts of this Sone
 358          */
 359         public List<Post> getPosts() {
 360                 return FluentIterable.from(posts).toSortedList(Post.TIME_COMPARATOR);
 361         }
 362
 363         /**
 364          * Returns all replies this Sone made.
 365          *
 366          * @return All replies this Sone made
 367          */
 368         public Set<PostReply> getReplies() {
 369                 return Collections.unmodifiableSet(replies);
 370         }
 371
 372         /**
 373          * Sets all replies of this Sone at once.
 374          *
 375          * @param replies
 376          *              The new (and only) replies of this Sone
 377          * @return This Sone (for method chaining)
 378          */
 379         public Sone setReplies(Collection<PostReply> replies) {
 380                 this.replies.clear();
 381                 this.replies.addAll(replies);
 382                 return this;
 383         }
 384
 385         /**
 386          * Adds a reply to this Sone. If the given reply was not made by this Sone,
 387          * nothing is added to this Sone.
 388          *
 389          * @param reply
 390          *              The reply to add
 391          */
 392         public void addReply(PostReply reply) {
 393                 if (reply.getSone().equals(this)) {
 394                         replies.add(reply);
 395                 }
 396         }
 397
 398         /**
 399          * Removes a reply from this Sone.
 400          *
 401          * @param reply
 402          *              The reply to remove
 403          */
 404         public void removeReply(PostReply reply) {
 405                 if (reply.getSone().equals(this)) {
 406                         replies.remove(reply);
 407                 }
 408         }
 409
 410         /**
 411          * Returns the IDs of all liked posts.
 412          *
 413          * @return All liked posts’ IDs
 414          */
 415         public Set<String> getLikedPostIds() {
 416                 return Collections.unmodifiableSet(likedPostIds);
 417         }
 418
 419         /**
 420          * Sets the IDs of all liked posts.
 421          *
 422          * @param likedPostIds
 423          *              All liked posts’ IDs
 424          * @return This Sone (for method chaining)
 425          */
 426         public Sone setLikePostIds(Set<String> likedPostIds) {
 427                 this.likedPostIds.clear();
 428                 this.likedPostIds.addAll(likedPostIds);
 429                 return this;
 430         }
 431
 432         /**
 433          * Checks whether the given post ID is liked by this Sone.
 434          *
 435          * @param postId
 436          *              The ID of the post
 437          * @return {@code true} if this Sone likes the given post, {@code false}
 438          *         otherwise
 439          */
 440         public boolean isLikedPostId(String postId) {
 441                 return likedPostIds.contains(postId);
 442         }
 443
 444         /**
 445          * Adds the given post ID to the list of posts this Sone likes.
 446          *
 447          * @param postId
 448          *              The ID of the post
 449          * @return This Sone (for method chaining)
 450          */
 451         public Sone addLikedPostId(String postId) {
 452                 likedPostIds.add(postId);
 453                 return this;
 454         }
 455
 456         /**
 457          * Removes the given post ID from the list of posts this Sone likes.
 458          *
 459          * @param postId
 460          *              The ID of the post
 461          * @return This Sone (for method chaining)
 462          */
 463         public Sone removeLikedPostId(String postId) {
 464                 likedPostIds.remove(postId);
 465                 return this;
 466         }
 467
 468         /**
 469          * Returns the IDs of all liked replies.
 470          *
 471          * @return All liked replies’ IDs
 472          */
 473         public Set<String> getLikedReplyIds() {
 474                 return Collections.unmodifiableSet(likedReplyIds);
 475         }
 476
 477         /**
 478          * Sets the IDs of all liked replies.
 479          *
 480          * @param likedReplyIds
 481          *              All liked replies’ IDs
 482          * @return This Sone (for method chaining)
 483          */
 484         public Sone setLikeReplyIds(Set<String> likedReplyIds) {
 485                 this.likedReplyIds.clear();
 486                 this.likedReplyIds.addAll(likedReplyIds);
 487                 return this;
 488         }
 489
 490         /**
 491          * Checks whether the given reply ID is liked by this Sone.
 492          *
 493          * @param replyId
 494          *              The ID of the reply
 495          * @return {@code true} if this Sone likes the given reply, {@code false}
 496          *         otherwise
 497          */
 498         public boolean isLikedReplyId(String replyId) {
 499                 return likedReplyIds.contains(replyId);
 500         }
 501
 502         /**
 503          * Adds the given reply ID to the list of replies this Sone likes.
 504          *
 505          * @param replyId
 506          *              The ID of the reply
 507          * @return This Sone (for method chaining)
 508          */
 509         public Sone addLikedReplyId(String replyId) {
 510                 likedReplyIds.add(replyId);
 511                 return this;
 512         }
 513
 514         /**
 515          * Removes the given post ID from the list of replies this Sone likes.
 516          *
 517          * @param replyId
 518          *              The ID of the reply
 519          * @return This Sone (for method chaining)
 520          */
 521         public Sone removeLikedReplyId(String replyId) {
 522                 likedReplyIds.remove(replyId);
 523                 return this;
 524         }
 525
 526         /**
 527          * Returns the root album that contains all visible albums of this Sone.
 528          *
 529          * @return The root album of this Sone
 530          */
 531         public Album getRootAlbum() {
 532                 return rootAlbum;
 533         }
 534
 535         /**
 536          * Returns Sone-specific options.
 537          *
 538          * @return The options of this Sone
 539          */
 540         public SoneOptions getOptions() {
 541                 return options;
 542         }
 543
 544         /**
 545          * Sets the options of this Sone.
 546          *
 547          * @param options
 548          *              The options of this Sone
 549          */
 550         /* TODO - remove this method again, maybe add an option provider */
 551         public void setOptions(SoneOptions options) {
 552                 this.options = options;
 553         }
 554
 555         //
 556         // FINGERPRINTABLE METHODS
 557         //
 558
 559         /** {@inheritDoc} */
 560         @Override
 561         public synchronized String getFingerprint() {
 562                 Hasher hash = Hashing.sha256().newHasher();
 563                 hash.putString(profile.getFingerprint());
 564
 565                 hash.putString("Posts(");
 566                 for (Post post : getPosts()) {
 567                         hash.putString("Post(").putString(post.getId()).putString(")");
 568                 }
 569                 hash.putString(")");
 570
 571                 List<PostReply> replies = new ArrayList<PostReply>(getReplies());
 572                 Collections.sort(replies, Reply.TIME_COMPARATOR);
 573                 hash.putString("Replies(");
 574                 for (PostReply reply : replies) {
 575                         hash.putString("Reply(").putString(reply.getId()).putString(")");
 576                 }
 577                 hash.putString(")");
 578
 579                 List<String> likedPostIds = new ArrayList<String>(getLikedPostIds());
 580                 Collections.sort(likedPostIds);
 581                 hash.putString("LikedPosts(");
 582                 for (String likedPostId : likedPostIds) {
 583                         hash.putString("Post(").putString(likedPostId).putString(")");
 584                 }
 585                 hash.putString(")");
 586
 587                 List<String> likedReplyIds = new ArrayList<String>(getLikedReplyIds());
 588                 Collections.sort(likedReplyIds);
 589                 hash.putString("LikedReplies(");
 590                 for (String likedReplyId : likedReplyIds) {
 591                         hash.putString("Reply(").putString(likedReplyId).putString(")");
 592                 }
 593                 hash.putString(")");
 594
 595                 hash.putString("Albums(");
 596                 for (Album album : rootAlbum.getAlbums()) {
 597                         if (!Album.NOT_EMPTY.apply(album)) {
 598                                 continue;
 599                         }
 600                         hash.putString(album.getFingerprint());
 601                 }
 602                 hash.putString(")");
 603
 604                 return hash.hash().toString();
 605         }
 606
 607         //
 608         // INTERFACE Comparable<Sone>
 609         //
 610
 611         /** {@inheritDoc} */
 612         @Override
 613         public int compareTo(Sone sone) {
 614                 return NICE_NAME_COMPARATOR.compare(this, sone);
 615         }
 616
 617         //
 618         // OBJECT METHODS
 619         //
 620
 621         /** {@inheritDoc} */
 622         @Override
 623         public int hashCode() {
 624                 return id.hashCode();
 625         }
 626
 627         /** {@inheritDoc} */
 628         @Override
 629         public boolean equals(Object object) {
 630                 if (!(object instanceof Sone)) {
 631                         return false;
 632                 }
 633                 return ((Sone) object).getId().equals(id);
 634         }
 635
 636         /** {@inheritDoc} */
 637         @Override
 638         public String toString() {
 639                 return getClass().getName() + "[identity=" + identity + ",posts(" + posts.size() + "),replies(" + replies.size() + "),albums(" + getRootAlbum().getAlbums().size() + ")]";
 640         }
 641
 642 }