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