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

   1 /*
   2  * Sone - Sone.java - Copyright © 2010–2016 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.data.Album.FLATTENER;
  23 import static net.pterodactylus.sone.data.Album.IMAGES;
  24
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.Comparator;
  28 import java.util.List;
  29 import java.util.Set;
  30
  31 import javax.annotation.Nonnull;
  32 import javax.annotation.Nullable;
  33
  34 import net.pterodactylus.sone.freenet.wot.Identity;
  35 import net.pterodactylus.sone.freenet.wot.OwnIdentity;
  36 import net.pterodactylus.sone.template.SoneAccessor;
  37
  38 import freenet.keys.FreenetURI;
  39
  40 import com.google.common.base.Function;
  41 import com.google.common.base.Predicate;
  42 import com.google.common.primitives.Ints;
  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) && (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) && (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) && !sone.getRootAlbum().getAlbums().isEmpty();
 171                 }
 172         };
 173
 174         public static final Function<Sone, List<Album>> toAllAlbums = new Function<Sone, List<Album>>() {
 175                 @Override
 176                 public List<Album> apply(@Nullable Sone sone) {
 177                         return (sone == null) ? Collections.<Album>emptyList() : FLATTENER.apply(
 178                                         sone.getRootAlbum());
 179                 }
 180         };
 181
 182         public static final Function<Sone, List<Image>> toAllImages = new Function<Sone, List<Image>>() {
 183                 @Override
 184                 public List<Image> apply(@Nullable Sone sone) {
 185                         return (sone == null) ? Collections.<Image>emptyList() :
 186                                         from(FLATTENER.apply(sone.getRootAlbum()))
 187                                                         .transformAndConcat(IMAGES).toList();
 188                 }
 189         };
 190
 191         /**
 192          * Returns the identity of this Sone.
 193          *
 194          * @return The identity of this Sone
 195          */
 196         Identity getIdentity();
 197
 198         /**
 199          * Returns the name of this Sone.
 200          *
 201          * @return The name of this Sone
 202          */
 203         String getName();
 204
 205         /**
 206          * Returns whether this Sone is a local Sone.
 207          *
 208          * @return {@code true} if this Sone is a local Sone, {@code false} otherwise
 209          */
 210         boolean isLocal();
 211
 212         /**
 213          * Returns the request URI of this Sone.
 214          *
 215          * @return The request URI of this Sone
 216          */
 217         FreenetURI getRequestUri();
 218
 219         /**
 220          * Returns the insert URI of this Sone.
 221          *
 222          * @return The insert URI of this Sone
 223          */
 224         FreenetURI getInsertUri();
 225
 226         /**
 227          * Returns the latest edition of this Sone.
 228          *
 229          * @return The latest edition of this Sone
 230          */
 231         long getLatestEdition();
 232
 233         /**
 234          * Sets the latest edition of this Sone. If the given latest edition is not
 235          * greater than the current latest edition, the latest edition of this Sone is
 236          * not changed.
 237          *
 238          * @param latestEdition
 239          *              The latest edition of this Sone
 240          */
 241         void setLatestEdition(long latestEdition);
 242
 243         /**
 244          * Return the time of the last inserted update of this Sone.
 245          *
 246          * @return The time of the update (in milliseconds since Jan 1, 1970 UTC)
 247          */
 248         long getTime();
 249
 250         /**
 251          * Sets the time of the last inserted update of this Sone.
 252          *
 253          * @param time
 254          *              The time of the update (in milliseconds since Jan 1, 1970 UTC)
 255          * @return This Sone (for method chaining)
 256          */
 257         Sone setTime(long time);
 258
 259         /**
 260          * Returns the status of this Sone.
 261          *
 262          * @return The status of this Sone
 263          */
 264         SoneStatus getStatus();
 265
 266         /**
 267          * Sets the new status of this Sone.
 268          *
 269          * @param status
 270          *              The new status of this Sone
 271          * @return This Sone
 272          * @throws IllegalArgumentException
 273          *              if {@code status} is {@code null}
 274          */
 275         Sone setStatus(SoneStatus status);
 276
 277         /**
 278          * Returns a copy of the profile. If you want to update values in the profile
 279          * of this Sone, update the values in the returned {@link Profile} and use
 280          * {@link #setProfile(Profile)} to change the profile in this Sone.
 281          *
 282          * @return A copy of the profile
 283          */
 284         Profile getProfile();
 285
 286         /**
 287          * Sets the profile of this Sone. A copy of the given profile is stored so that
 288          * subsequent modifications of the given profile are not reflected in this
 289          * Sone!
 290          *
 291          * @param profile
 292          *              The profile to set
 293          */
 294         void setProfile(Profile profile);
 295
 296         /**
 297          * Returns the client used by this Sone.
 298          *
 299          * @return The client used by this Sone, or {@code null}
 300          */
 301         Client getClient();
 302
 303         /**
 304          * Sets the client used by this Sone.
 305          *
 306          * @param client
 307          *              The client used by this Sone, or {@code null}
 308          * @return This Sone (for method chaining)
 309          */
 310         Sone setClient(Client client);
 311
 312         /**
 313          * Returns whether this Sone is known.
 314          *
 315          * @return {@code true} if this Sone is known, {@code false} otherwise
 316          */
 317         boolean isKnown();
 318
 319         /**
 320          * Sets whether this Sone is known.
 321          *
 322          * @param known
 323          *              {@code true} if this Sone is known, {@code false} otherwise
 324          * @return This Sone
 325          */
 326         Sone setKnown(boolean known);
 327
 328         /**
 329          * Returns all friend Sones of this Sone.
 330          *
 331          * @return The friend Sones of this Sone
 332          */
 333         Collection<String> getFriends();
 334
 335         /**
 336          * Returns whether this Sone has the given Sone as a friend Sone.
 337          *
 338          * @param friendSoneId
 339          *              The ID of the Sone to check for
 340          * @return {@code true} if this Sone has the given Sone as a friend, {@code
 341          *         false} otherwise
 342          */
 343         boolean hasFriend(String friendSoneId);
 344
 345         /**
 346          * Returns the list of posts of this Sone, sorted by time, newest first.
 347          *
 348          * @return All posts of this Sone
 349          */
 350         List<Post> getPosts();
 351
 352         /**
 353          * Sets all posts of this Sone at once.
 354          *
 355          * @param posts
 356          *              The new (and only) posts of this Sone
 357          * @return This Sone (for method chaining)
 358          */
 359         Sone setPosts(Collection<Post> posts);
 360
 361         /**
 362          * Adds the given post to this Sone. The post will not be added if its {@link
 363          * Post#getSone() Sone} is not this Sone.
 364          *
 365          * @param post
 366          *              The post to add
 367          */
 368         void addPost(Post post);
 369
 370         /**
 371          * Removes the given post from this Sone.
 372          *
 373          * @param post
 374          *              The post to remove
 375          */
 376         void removePost(Post post);
 377
 378         /**
 379          * Returns all replies this Sone made.
 380          *
 381          * @return All replies this Sone made
 382          */
 383         Set<PostReply> getReplies();
 384
 385         /**
 386          * Sets all replies of this Sone at once.
 387          *
 388          * @param replies
 389          *              The new (and only) replies of this Sone
 390          * @return This Sone (for method chaining)
 391          */
 392         Sone setReplies(Collection<PostReply> replies);
 393
 394         /**
 395          * Adds a reply to this Sone. If the given reply was not made by this Sone,
 396          * nothing is added to this Sone.
 397          *
 398          * @param reply
 399          *              The reply to add
 400          */
 401         void addReply(PostReply reply);
 402
 403         /**
 404          * Removes a reply from this Sone.
 405          *
 406          * @param reply
 407          *              The reply to remove
 408          */
 409         void removeReply(PostReply reply);
 410
 411         /**
 412          * Returns the IDs of all liked posts.
 413          *
 414          * @return All liked posts’ IDs
 415          */
 416         Set<String> getLikedPostIds();
 417
 418         /**
 419          * Sets the IDs of all liked posts.
 420          *
 421          * @param likedPostIds
 422          *              All liked posts’ IDs
 423          * @return This Sone (for method chaining)
 424          */
 425         Sone setLikePostIds(Set<String> likedPostIds);
 426
 427         /**
 428          * Checks whether the given post ID is liked by this Sone.
 429          *
 430          * @param postId
 431          *              The ID of the post
 432          * @return {@code true} if this Sone likes the given post, {@code false}
 433          *         otherwise
 434          */
 435         boolean isLikedPostId(String postId);
 436
 437         /**
 438          * Adds the given post ID to the list of posts this Sone likes.
 439          *
 440          * @param postId
 441          *              The ID of the post
 442          * @return This Sone (for method chaining)
 443          */
 444         Sone addLikedPostId(String postId);
 445
 446         /**
 447          * Removes the given post ID from the list of posts this Sone likes.
 448          *
 449          * @param postId
 450          *              The ID of the post
 451          * @return This Sone (for method chaining)
 452          */
 453         Sone removeLikedPostId(String postId);
 454
 455         /**
 456          * Returns the IDs of all liked replies.
 457          *
 458          * @return All liked replies’ IDs
 459          */
 460         Set<String> getLikedReplyIds();
 461
 462         /**
 463          * Sets the IDs of all liked replies.
 464          *
 465          * @param likedReplyIds
 466          *              All liked replies’ IDs
 467          * @return This Sone (for method chaining)
 468          */
 469         Sone setLikeReplyIds(Set<String> likedReplyIds);
 470
 471         /**
 472          * Checks whether the given reply ID is liked by this Sone.
 473          *
 474          * @param replyId
 475          *              The ID of the reply
 476          * @return {@code true} if this Sone likes the given reply, {@code false}
 477          *         otherwise
 478          */
 479         boolean isLikedReplyId(String replyId);
 480
 481         /**
 482          * Adds the given reply ID to the list of replies this Sone likes.
 483          *
 484          * @param replyId
 485          *              The ID of the reply
 486          * @return This Sone (for method chaining)
 487          */
 488         Sone addLikedReplyId(String replyId);
 489
 490         /**
 491          * Removes the given post ID from the list of replies this Sone likes.
 492          *
 493          * @param replyId
 494          *              The ID of the reply
 495          * @return This Sone (for method chaining)
 496          */
 497         Sone removeLikedReplyId(String replyId);
 498
 499         /**
 500          * Returns the root album that contains all visible albums of this Sone.
 501          *
 502          * @return The root album of this Sone
 503          */
 504         Album getRootAlbum();
 505
 506         /**
 507          * Returns Sone-specific options.
 508          *
 509          * @return The options of this Sone
 510          */
 511         SoneOptions getOptions();
 512
 513         /**
 514          * Sets the options of this Sone.
 515          *
 516          * @param options
 517          *              The options of this Sone
 518          */
 519         /* TODO - remove this method again, maybe add an option provider */
 520         void setOptions(SoneOptions options);
 521
 522 }