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