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