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