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

   1 /*
   2  * Sone - Sone.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;
  19
  20 import static com.google.common.collect.FluentIterable.from;
  21 import static java.util.Arrays.asList;
  22 import static net.pterodactylus.sone.core.SoneUri.create;
  23 import static net.pterodactylus.sone.data.Album.FLATTENER;
  24 import static net.pterodactylus.sone.data.Album.IMAGES;
  25
  26 import java.util.Collection;
  27 import java.util.Comparator;
  28 import java.util.List;
  29 import java.util.Set;
  30
  31 import net.pterodactylus.sone.core.Options;
  32 import net.pterodactylus.sone.database.AlbumBuilder;
  33 import net.pterodactylus.sone.database.PostBuilder;
  34 import net.pterodactylus.sone.database.PostReplyBuilder;
  35 import net.pterodactylus.sone.freenet.wot.Identity;
  36 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  37 import net.pterodactylus.sone.template.SoneAccessor;
  38
  39 import com.google.common.base.Function;
  40 import com.google.common.base.Predicate;
  41 import com.google.common.primitives.Ints;
  42 import freenet.keys.FreenetURI;
  43
  44 /**
  45  * A Sone defines everything about a user: her profile, her status updates, her
  46  * replies, her likes and dislikes, etc.
  47  *
  48  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  49  */
  50 public interface Sone extends Identified, Fingerprintable, Comparable<Sone> {
  51
  52         /**
  53          * Enumeration for the possible states of a {@link Sone}.
  54          *
  55          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  56          */
  57         public enum SoneStatus {
  58
  59                 /** The Sone is unknown, i.e. not yet downloaded. */
  60                 unknown,
  61
  62                 /** The Sone is idle, i.e. not being downloaded or inserted. */
  63                 idle,
  64
  65                 /** The Sone is currently being inserted. */
  66                 inserting,
  67
  68                 /** The Sone is currently being downloaded. */
  69                 downloading,
  70         }
  71
  72         /**
  73          * The possible values for the “show custom avatars” option.
  74          *
  75          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  76          */
  77         public static enum ShowCustomAvatars {
  78
  79                 /** Never show custom avatars. */
  80                 NEVER,
  81
  82                 /** Only show custom avatars of followed Sones. */
  83                 FOLLOWED,
  84
  85                 /** Only show custom avatars of Sones you manually trust. */
  86                 MANUALLY_TRUSTED,
  87
  88                 /** Only show custom avatars of automatically trusted Sones. */
  89                 TRUSTED,
  90
  91                 /** Always show custom avatars. */
  92                 ALWAYS,
  93
  94         }
  95
  96         /** comparator that sorts Sones by their nice name. */
  97         public static final Comparator<Sone> NICE_NAME_COMPARATOR = new Comparator<Sone>() {
  98
  99                 @Override
 100                 public int compare(Sone leftSone, Sone rightSone) {
 101                         int diff = SoneAccessor.getNiceName(leftSone).compareToIgnoreCase(SoneAccessor.getNiceName(rightSone));
 102                         if (diff != 0) {
 103                                 return diff;
 104                         }
 105                         return leftSone.getId().compareToIgnoreCase(rightSone.getId());
 106                 }
 107
 108         };
 109
 110         /** Comparator that sorts Sones by last activity (least recent active first). */
 111         public static final Comparator<Sone> LAST_ACTIVITY_COMPARATOR = new Comparator<Sone>() {
 112
 113                 @Override
 114                 public int compare(Sone firstSone, Sone secondSone) {
 115                         return (int) Math.min(Integer.MAX_VALUE, Math.max(Integer.MIN_VALUE, secondSone.getTime() - firstSone.getTime()));
 116                 }
 117         };
 118
 119         /** Comparator that sorts Sones by numbers of posts (descending). */
 120         public static final Comparator<Sone> POST_COUNT_COMPARATOR = new Comparator<Sone>() {
 121
 122                 /**
 123                  * {@inheritDoc}
 124                  */
 125                 @Override
 126                 public int compare(Sone leftSone, Sone rightSone) {
 127                         return (leftSone.getPosts().size() != rightSone.getPosts().size()) ? (rightSone.getPosts().size() - leftSone.getPosts().size()) : (rightSone.getReplies().size() - leftSone.getReplies().size());
 128                 }
 129         };
 130
 131         /** Comparator that sorts Sones by number of images (descending). */
 132         public static final Comparator<Sone> IMAGE_COUNT_COMPARATOR = new Comparator<Sone>() {
 133
 134                 /**
 135                  * {@inheritDoc}
 136                  */
 137                 @Override
 138                 public int compare(Sone leftSone, Sone rightSone) {
 139                         int rightSoneImageCount = from(asList(rightSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
 140                         int leftSoneImageCount = from(asList(leftSone.getRootAlbum())).transformAndConcat(FLATTENER).transformAndConcat(IMAGES).size();
 141                         /* sort descending. */
 142                         return Ints.compare(rightSoneImageCount, leftSoneImageCount);
 143                 }
 144         };
 145
 146         /** Filter to remove Sones that have not been downloaded. */
 147         public static final Predicate<Sone> EMPTY_SONE_FILTER = new Predicate<Sone>() {
 148
 149                 @Override
 150                 public boolean apply(Sone sone) {
 151                         return (sone == null) ? false : sone.getTime() != 0;
 152                 }
 153         };
 154
 155         /** Filter that matches all {@link Sone#isLocal() local Sones}. */
 156         public static final Predicate<Sone> LOCAL_SONE_FILTER = new Predicate<Sone>() {
 157
 158                 @Override
 159                 public boolean apply(Sone sone) {
 160                         return (sone == null) ? false : sone.getIdentity() instanceof OwnIdentity;
 161                 }
 162
 163         };
 164
 165         /** Filter that matches Sones that have at least one album. */
 166         public static final Predicate<Sone> HAS_ALBUM_FILTER = new Predicate<Sone>() {
 167
 168                 @Override
 169                 public boolean apply(Sone sone) {
 170                         return (sone == null) ? false : !sone.getRootAlbum().getAlbums().isEmpty();
 171                 }
 172         };
 173
 174         public static final Function<Sone, FreenetURI> TO_FREENET_URI = new Function<Sone, FreenetURI>() {
 175                 @Override
 176                 public FreenetURI apply(Sone sone) {
 177                         return (sone == null) ? null : create(sone.getIdentity().getRequestUri());
 178                 }
 179         };
 180
 181         /**
 182          * Returns the identity of this Sone.
 183          *
 184          * @return The identity of this Sone
 185          */
 186         Identity getIdentity();
 187
 188         /**
 189          * Returns the name of this Sone.
 190          *
 191          * @return The name of this Sone
 192          */
 193         String getName();
 194
 195         /**
 196          * Returns whether this Sone is a local Sone.
 197          *
 198          * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
 199          */
 200         boolean isLocal();
 201
 202         /**
 203          * Returns the latest edition of this Sone.
 204          *
 205          * @return The latest edition of this Sone
 206          */
 207         long getLatestEdition();
 208
 209         /**
 210          * Sets the latest edition of this Sone. If the given latest edition is not
 211          * greater than the current latest edition, the latest edition of this Sone is
 212          * not changed.
 213          *
 214          * @param latestEdition
 215          *              The latest edition of this Sone
 216          */
 217         void setLatestEdition(long latestEdition);
 218
 219         /**
 220          * Return the time of the last inserted update of this Sone.
 221          *
 222          * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
 223          */
 224         long getTime();
 225
 226         /**
 227          * Sets the time of the last inserted update of this Sone.
 228          *
 229          * @param time
 230          *              The time of the update (in milliseconds since Jan 1, 1970 UTC)
 231          * @return This Sone (for method chaining)
 232          */
 233         Sone setTime(long time);
 234
 235         /**
 236          * Returns the status of this Sone.
 237          *
 238          * @return The status of this Sone
 239          */
 240         SoneStatus getStatus();
 241
 242         /**
 243          * Sets the new status of this Sone.
 244          *
 245          * @param status
 246          *              The new status of this Sone
 247          * @return This Sone
 248          * @throws IllegalArgumentException
 249          *              if {@code status} is {@code null}
 250          */
 251         Sone setStatus(SoneStatus status);
 252
 253         /**
 254          * Returns a copy of the profile. If you want to update values in the profile
 255          * of this Sone, update the values in the returned {@link Profile} and use
 256          * {@link #setProfile(Profile)} to change the profile in this Sone.
 257          *
 258          * @return A copy of the profile
 259          */
 260         Profile getProfile();
 261
 262         /**
 263          * Sets the profile of this Sone. A copy of the given profile is stored so that
 264          * subsequent modifications of the given profile are not reflected in this
 265          * Sone!
 266          *
 267          * @param profile
 268          *              The profile to set
 269          */
 270         void setProfile(Profile profile);
 271
 272         /**
 273          * Returns the client used by this Sone.
 274          *
 275          * @return The client used by this Sone, or {@code null}
 276          */
 277         Client getClient();
 278
 279         /**
 280          * Sets the client used by this Sone.
 281          *
 282          * @param client
 283          *              The client used by this Sone, or {@code null}
 284          * @return This Sone (for method chaining)
 285          */
 286         Sone setClient(Client client);
 287
 288         /**
 289          * Returns whether this Sone is known.
 290          *
 291          * @return {@code true} if this Sone is known, {@code false} otherwise
 292          */
 293         boolean isKnown();
 294
 295         /**
 296          * Sets whether this Sone is known.
 297          *
 298          * @param known
 299          *              {@code true} if this Sone is known, {@code false} otherwise
 300          * @return This Sone
 301          */
 302         Sone setKnown(boolean known);
 303
 304         /**
 305          * Returns all friend Sones of this Sone.
 306          *
 307          * @return The friend Sones of this Sone
 308          */
 309         List<String> getFriends();
 310
 311         /**
 312          * Returns whether this Sone has the given Sone as a friend Sone.
 313          *
 314          * @param friendSoneId
 315          *              The ID of the Sone to check for
 316          * @return {@code true} if this Sone has the given Sone as a friend, {@code
 317          *         false} otherwise
 318          */
 319         boolean hasFriend(String friendSoneId);
 320
 321         /**
 322          * Adds the given Sone as a friend Sone.
 323          *
 324          * @param friendSone
 325          *              The friend Sone to add
 326          * @return This Sone (for method chaining)
 327          */
 328         Sone addFriend(String friendSone);
 329
 330         /**
 331          * Removes the given Sone as a friend Sone.
 332          *
 333          * @param friendSoneId
 334          *              The ID of the friend Sone to remove
 335          * @return This Sone (for method chaining)
 336          */
 337         Sone removeFriend(String friendSoneId);
 338
 339         /**
 340          * Returns the list of posts of this Sone, sorted by time, newest first.
 341          *
 342          * @return All posts of this Sone
 343          */
 344         List<Post> getPosts();
 345
 346         /**
 347          * Sets all posts of this Sone at once.
 348          *
 349          * @param posts
 350          *              The new (and only) posts of this Sone
 351          * @return This Sone (for method chaining)
 352          */
 353         Sone setPosts(Collection<Post> posts);
 354
 355         /**
 356          * Adds the given post to this Sone. The post will not be added if its {@link
 357          * Post#getSone() Sone} is not this Sone.
 358          *
 359          * @param post
 360          *              The post to add
 361          */
 362         void addPost(Post post);
 363
 364         /**
 365          * Removes the given post from this Sone.
 366          *
 367          * @param post
 368          *              The post to remove
 369          */
 370         void removePost(Post post);
 371
 372         /**
 373          * Returns all replies this Sone made.
 374          *
 375          * @return All replies this Sone made
 376          */
 377         Set<PostReply> getReplies();
 378
 379         /**
 380          * Sets all replies of this Sone at once.
 381          *
 382          * @param replies
 383          *              The new (and only) replies of this Sone
 384          * @return This Sone (for method chaining)
 385          */
 386         Sone setReplies(Collection<PostReply> replies);
 387
 388         /**
 389          * Adds a reply to this Sone. If the given reply was not made by this Sone,
 390          * nothing is added to this Sone.
 391          *
 392          * @param reply
 393          *              The reply to add
 394          */
 395         void addReply(PostReply reply);
 396
 397         /**
 398          * Removes a reply from this Sone.
 399          *
 400          * @param reply
 401          *              The reply to remove
 402          */
 403         void removeReply(PostReply reply);
 404
 405         /**
 406          * Returns the IDs of all liked posts.
 407          *
 408          * @return All liked posts’ IDs
 409          */
 410         Set<String> getLikedPostIds();
 411
 412         /**
 413          * Sets the IDs of all liked posts.
 414          *
 415          * @param likedPostIds
 416          *              All liked posts’ IDs
 417          * @return This Sone (for method chaining)
 418          */
 419         Sone setLikePostIds(Set<String> likedPostIds);
 420
 421         /**
 422          * Checks whether the given post ID is liked by this Sone.
 423          *
 424          * @param postId
 425          *              The ID of the post
 426          * @return {@code true} if this Sone likes the given post, {@code false}
 427          *         otherwise
 428          */
 429         boolean isLikedPostId(String postId);
 430
 431         /**
 432          * Adds the given post ID to the list of posts this Sone likes.
 433          *
 434          * @param postId
 435          *              The ID of the post
 436          * @return This Sone (for method chaining)
 437          */
 438         Sone addLikedPostId(String postId);
 439
 440         /**
 441          * Removes the given post ID from the list of posts this Sone likes.
 442          *
 443          * @param postId
 444          *              The ID of the post
 445          * @return This Sone (for method chaining)
 446          */
 447         Sone removeLikedPostId(String postId);
 448
 449         /**
 450          * Returns the IDs of all liked replies.
 451          *
 452          * @return All liked replies’ IDs
 453          */
 454         Set<String> getLikedReplyIds();
 455
 456         /**
 457          * Sets the IDs of all liked replies.
 458          *
 459          * @param likedReplyIds
 460          *              All liked replies’ IDs
 461          * @return This Sone (for method chaining)
 462          */
 463         Sone setLikeReplyIds(Set<String> likedReplyIds);
 464
 465         /**
 466          * Checks whether the given reply ID is liked by this Sone.
 467          *
 468          * @param replyId
 469          *              The ID of the reply
 470          * @return {@code true} if this Sone likes the given reply, {@code false}
 471          *         otherwise
 472          */
 473         boolean isLikedReplyId(String replyId);
 474
 475         /**
 476          * Adds the given reply ID to the list of replies this Sone likes.
 477          *
 478          * @param replyId
 479          *              The ID of the reply
 480          * @return This Sone (for method chaining)
 481          */
 482         Sone addLikedReplyId(String replyId);
 483
 484         /**
 485          * Removes the given post ID from the list of replies this Sone likes.
 486          *
 487          * @param replyId
 488          *              The ID of the reply
 489          * @return This Sone (for method chaining)
 490          */
 491         Sone removeLikedReplyId(String replyId);
 492
 493         /**
 494          * Returns the root album that contains all visible albums of this Sone.
 495          *
 496          * @return The root album of this Sone
 497          */
 498         Album getRootAlbum();
 499
 500         /**
 501          * Returns Sone-specific options.
 502          *
 503          * @return The options of this Sone
 504          */
 505         Options getOptions();
 506
 507         /**
 508          * Sets the options of this Sone.
 509          *
 510          * @param options
 511          *              The options of this Sone
 512          */
 513         /* TODO - remove this method again, maybe add an option provider */
 514         void setOptions(Options options);
 515
 516         AlbumBuilder newAlbumBuilder() throws IllegalStateException;
 517
 518         PostBuilder newPostBuilder();
 519
 520         PostReplyBuilder newPostReplyBuilder(String postId) throws IllegalStateException;
 521
 522 }