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