2 * Sone - MemoryDatabase.java - Copyright © 2013–2016 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.database.memory;
20 import static com.google.common.base.Optional.fromNullable;
21 import static com.google.common.base.Preconditions.checkNotNull;
22 import static com.google.common.base.Predicates.not;
23 import static com.google.common.collect.FluentIterable.from;
24 import static net.pterodactylus.sone.data.Reply.TIME_COMPARATOR;
25 import static net.pterodactylus.sone.data.Sone.LOCAL_SONE_FILTER;
26 import static net.pterodactylus.sone.data.Sone.toAllAlbums;
27 import static net.pterodactylus.sone.data.Sone.toAllImages;
29 import java.util.Collection;
30 import java.util.Collections;
31 import java.util.Comparator;
32 import java.util.HashMap;
33 import java.util.HashSet;
34 import java.util.List;
37 import java.util.concurrent.locks.ReadWriteLock;
38 import java.util.concurrent.locks.ReentrantReadWriteLock;
40 import javax.annotation.Nonnull;
41 import javax.annotation.Nullable;
43 import net.pterodactylus.sone.data.Album;
44 import net.pterodactylus.sone.data.Image;
45 import net.pterodactylus.sone.data.Post;
46 import net.pterodactylus.sone.data.PostReply;
47 import net.pterodactylus.sone.data.Sone;
48 import net.pterodactylus.sone.data.impl.AlbumBuilderImpl;
49 import net.pterodactylus.sone.data.impl.ImageBuilderImpl;
50 import net.pterodactylus.sone.database.AlbumBuilder;
51 import net.pterodactylus.sone.database.Database;
52 import net.pterodactylus.sone.database.DatabaseException;
53 import net.pterodactylus.sone.database.ImageBuilder;
54 import net.pterodactylus.sone.database.PostBuilder;
55 import net.pterodactylus.sone.database.PostDatabase;
56 import net.pterodactylus.sone.database.PostReplyBuilder;
57 import net.pterodactylus.sone.database.SoneBuilder;
58 import net.pterodactylus.util.config.Configuration;
59 import net.pterodactylus.util.config.ConfigurationException;
61 import com.google.common.base.Predicate;
62 import com.google.common.collect.HashMultimap;
63 import com.google.common.collect.Multimap;
64 import com.google.common.collect.SortedSetMultimap;
65 import com.google.common.collect.TreeMultimap;
66 import com.google.common.util.concurrent.AbstractService;
67 import com.google.inject.Inject;
68 import com.google.inject.Singleton;
69 import kotlin.jvm.functions.Function1;
72 * Memory-based {@link PostDatabase} implementation.
74 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
77 public class MemoryDatabase extends AbstractService implements Database {
80 private final ReadWriteLock lock = new ReentrantReadWriteLock();
82 /** The configuration. */
83 private final Configuration configuration;
84 private final ConfigurationLoader configurationLoader;
86 private final Map<String, Sone> allSones = new HashMap<String, Sone>();
88 /** All posts by their ID. */
89 private final Map<String, Post> allPosts = new HashMap<String, Post>();
91 /** All posts by their Sones. */
92 private final Multimap<String, Post> sonePosts = HashMultimap.create();
94 /** Whether posts are known. */
95 private final Set<String> knownPosts = new HashSet<String>();
97 /** All post replies by their ID. */
98 private final Map<String, PostReply> allPostReplies = new HashMap<String, PostReply>();
100 /** Replies sorted by Sone. */
101 private final SortedSetMultimap<String, PostReply> sonePostReplies = TreeMultimap.create(new Comparator<String>() {
104 public int compare(String leftString, String rightString) {
105 return leftString.compareTo(rightString);
109 /** Whether post replies are known. */
110 private final Set<String> knownPostReplies = new HashSet<String>();
112 private final Map<String, Album> allAlbums = new HashMap<String, Album>();
113 private final Multimap<String, Album> soneAlbums = HashMultimap.create();
115 private final Map<String, Image> allImages = new HashMap<String, Image>();
116 private final Multimap<String, Image> soneImages = HashMultimap.create();
118 private final MemoryBookmarkDatabase memoryBookmarkDatabase;
119 private final MemoryFriendDatabase memoryFriendDatabase;
122 * Creates a new memory database.
124 * @param configuration
125 * The configuration for loading and saving elements
128 public MemoryDatabase(Configuration configuration) {
129 this.configuration = configuration;
130 this.configurationLoader = new ConfigurationLoader(configuration);
131 memoryBookmarkDatabase =
132 new MemoryBookmarkDatabase(this, configurationLoader);
133 memoryFriendDatabase = new MemoryFriendDatabase(configurationLoader);
141 * Saves the database.
143 * @throws DatabaseException
144 * if an error occurs while saving
147 public void save() throws DatabaseException {
149 saveKnownPostReplies();
156 /** {@inheritDocs} */
158 protected void doStart() {
159 memoryBookmarkDatabase.start();
161 loadKnownPostReplies();
165 /** {@inheritDocs} */
167 protected void doStop() {
169 memoryBookmarkDatabase.stop();
172 } catch (DatabaseException de1) {
178 public SoneBuilder newSoneBuilder() {
179 return new MemorySoneBuilder(this);
183 public void storeSone(Sone sone) {
184 lock.writeLock().lock();
188 allSones.put(sone.getId(), sone);
189 sonePosts.putAll(sone.getId(), sone.getPosts());
190 for (Post post : sone.getPosts()) {
191 allPosts.put(post.getId(), post);
193 sonePostReplies.putAll(sone.getId(), sone.getReplies());
194 for (PostReply postReply : sone.getReplies()) {
195 allPostReplies.put(postReply.getId(), postReply);
197 soneAlbums.putAll(sone.getId(), toAllAlbums.apply(sone));
198 for (Album album : toAllAlbums.apply(sone)) {
199 allAlbums.put(album.getId(), album);
201 soneImages.putAll(sone.getId(), toAllImages.apply(sone));
202 for (Image image : toAllImages.apply(sone)) {
203 allImages.put(image.getId(), image);
206 lock.writeLock().unlock();
211 public void removeSone(Sone sone) {
212 lock.writeLock().lock();
214 allSones.remove(sone.getId());
215 Collection<Post> removedPosts = sonePosts.removeAll(sone.getId());
216 for (Post removedPost : removedPosts) {
217 allPosts.remove(removedPost.getId());
219 Collection<PostReply> removedPostReplies =
220 sonePostReplies.removeAll(sone.getId());
221 for (PostReply removedPostReply : removedPostReplies) {
222 allPostReplies.remove(removedPostReply.getId());
224 Collection<Album> removedAlbums =
225 soneAlbums.removeAll(sone.getId());
226 for (Album removedAlbum : removedAlbums) {
227 allAlbums.remove(removedAlbum.getId());
229 Collection<Image> removedImages =
230 soneImages.removeAll(sone.getId());
231 for (Image removedImage : removedImages) {
232 allImages.remove(removedImage.getId());
235 lock.writeLock().unlock();
241 public Function1<String, Sone> getSoneLoader() {
242 return new Function1<String, Sone>() {
244 public Sone invoke(String soneId) {
245 return getSone(soneId);
251 public Sone getSone(String soneId) {
252 lock.readLock().lock();
254 return allSones.get(soneId);
256 lock.readLock().unlock();
261 public Collection<Sone> getSones() {
262 lock.readLock().lock();
264 return new HashSet<Sone>(allSones.values());
266 lock.readLock().unlock();
271 public Collection<Sone> getLocalSones() {
272 lock.readLock().lock();
274 return from(allSones.values()).filter(LOCAL_SONE_FILTER).toSet();
276 lock.readLock().unlock();
281 public Collection<Sone> getRemoteSones() {
282 lock.readLock().lock();
284 return from(allSones.values())
285 .filter(not(LOCAL_SONE_FILTER)) .toSet();
287 lock.readLock().unlock();
292 public Collection<String> getFriends(Sone localSone) {
293 if (!localSone.isLocal()) {
294 return Collections.emptySet();
296 return memoryFriendDatabase.getFriends(localSone.getId());
300 public boolean isFriend(Sone localSone, String friendSoneId) {
301 if (!localSone.isLocal()) {
304 return memoryFriendDatabase.isFriend(localSone.getId(), friendSoneId);
308 public void addFriend(Sone localSone, String friendSoneId) {
309 if (!localSone.isLocal()) {
312 memoryFriendDatabase.addFriend(localSone.getId(), friendSoneId);
316 public void removeFriend(Sone localSone, String friendSoneId) {
317 if (!localSone.isLocal()) {
320 memoryFriendDatabase.removeFriend(localSone.getId(), friendSoneId);
325 public Long getFollowingTime(@Nonnull String friendSoneId) {
326 return memoryFriendDatabase.getFollowingTime(friendSoneId);
330 // POSTPROVIDER METHODS
335 public Post getPost(@Nonnull String postId) {
336 lock.readLock().lock();
338 return allPosts.get(postId);
340 lock.readLock().unlock();
344 /** {@inheritDocs} */
346 public Collection<Post> getPosts(String soneId) {
347 return new HashSet<Post>(getPostsFrom(soneId));
350 /** {@inheritDocs} */
352 public Collection<Post> getDirectedPosts(final String recipientId) {
353 lock.readLock().lock();
355 return from(sonePosts.values()).filter(new Predicate<Post>() {
357 public boolean apply(Post post) {
358 return post.getRecipientId().asSet().contains(recipientId);
362 lock.readLock().unlock();
367 // POSTBUILDERFACTORY METHODS
370 /** {@inheritDocs} */
372 public PostBuilder newPostBuilder() {
373 return new MemoryPostBuilder(this, this);
380 /** {@inheritDocs} */
382 public void storePost(Post post) {
383 checkNotNull(post, "post must not be null");
384 lock.writeLock().lock();
386 allPosts.put(post.getId(), post);
387 getPostsFrom(post.getSone().getId()).add(post);
389 lock.writeLock().unlock();
393 /** {@inheritDocs} */
395 public void removePost(Post post) {
396 checkNotNull(post, "post must not be null");
397 lock.writeLock().lock();
399 allPosts.remove(post.getId());
400 getPostsFrom(post.getSone().getId()).remove(post);
401 post.getSone().removePost(post);
403 lock.writeLock().unlock();
408 // POSTREPLYPROVIDER METHODS
413 public PostReply getPostReply(String id) {
414 lock.readLock().lock();
416 return allPostReplies.get(id);
418 lock.readLock().unlock();
422 /** {@inheritDocs} */
424 public List<PostReply> getReplies(final String postId) {
425 lock.readLock().lock();
427 return from(allPostReplies.values())
428 .filter(new Predicate<PostReply>() {
430 public boolean apply(PostReply postReply) {
431 return postReply.getPostId().equals(postId);
433 }).toSortedList(TIME_COMPARATOR);
435 lock.readLock().unlock();
440 // POSTREPLYBUILDERFACTORY METHODS
443 /** {@inheritDocs} */
445 public PostReplyBuilder newPostReplyBuilder() {
446 return new MemoryPostReplyBuilder(this, this);
450 // POSTREPLYSTORE METHODS
453 /** {@inheritDocs} */
455 public void storePostReply(PostReply postReply) {
456 lock.writeLock().lock();
458 allPostReplies.put(postReply.getId(), postReply);
460 lock.writeLock().unlock();
464 /** {@inheritDocs} */
466 public void removePostReply(PostReply postReply) {
467 lock.writeLock().lock();
469 allPostReplies.remove(postReply.getId());
471 lock.writeLock().unlock();
476 // ALBUMPROVDER METHODS
481 public Album getAlbum(@Nonnull String albumId) {
482 lock.readLock().lock();
484 return allAlbums.get(albumId);
486 lock.readLock().unlock();
491 // ALBUMBUILDERFACTORY METHODS
495 public AlbumBuilder newAlbumBuilder() {
496 return new AlbumBuilderImpl();
500 // ALBUMSTORE METHODS
504 public void storeAlbum(Album album) {
505 lock.writeLock().lock();
507 allAlbums.put(album.getId(), album);
508 soneAlbums.put(album.getSone().getId(), album);
510 lock.writeLock().unlock();
515 public void removeAlbum(Album album) {
516 lock.writeLock().lock();
518 allAlbums.remove(album.getId());
519 soneAlbums.remove(album.getSone().getId(), album);
521 lock.writeLock().unlock();
526 // IMAGEPROVIDER METHODS
531 public Image getImage(@Nonnull String imageId) {
532 lock.readLock().lock();
534 return allImages.get(imageId);
536 lock.readLock().unlock();
541 // IMAGEBUILDERFACTORY METHODS
545 public ImageBuilder newImageBuilder() {
546 return new ImageBuilderImpl();
550 // IMAGESTORE METHODS
554 public void storeImage(Image image) {
555 lock.writeLock().lock();
557 allImages.put(image.getId(), image);
558 soneImages.put(image.getSone().getId(), image);
560 lock.writeLock().unlock();
565 public void removeImage(Image image) {
566 lock.writeLock().lock();
568 allImages.remove(image.getId());
569 soneImages.remove(image.getSone().getId(), image);
571 lock.writeLock().unlock();
576 public void bookmarkPost(Post post) {
577 memoryBookmarkDatabase.bookmarkPost(post);
581 public void unbookmarkPost(Post post) {
582 memoryBookmarkDatabase.unbookmarkPost(post);
586 public boolean isPostBookmarked(Post post) {
587 return memoryBookmarkDatabase.isPostBookmarked(post);
591 public Set<Post> getBookmarkedPosts() {
592 return memoryBookmarkDatabase.getBookmarkedPosts();
596 // PACKAGE-PRIVATE METHODS
600 * Returns whether the given post is known.
604 * @return {@code true} if the post is known, {@code false} otherwise
606 boolean isPostKnown(Post post) {
607 lock.readLock().lock();
609 return knownPosts.contains(post.getId());
611 lock.readLock().unlock();
616 * Sets whether the given post is known.
621 * {@code true} if the post is known, {@code false} otherwise
623 void setPostKnown(Post post, boolean known) {
624 lock.writeLock().lock();
627 knownPosts.add(post.getId());
629 knownPosts.remove(post.getId());
632 lock.writeLock().unlock();
637 * Returns whether the given post reply is known.
641 * @return {@code true} if the given post reply is known, {@code false}
644 boolean isPostReplyKnown(PostReply postReply) {
645 lock.readLock().lock();
647 return knownPostReplies.contains(postReply.getId());
649 lock.readLock().unlock();
654 * Sets whether the given post reply is known.
659 * {@code true} if the post reply is known, {@code false} otherwise
661 void setPostReplyKnown(PostReply postReply, boolean known) {
662 lock.writeLock().lock();
665 knownPostReplies.add(postReply.getId());
667 knownPostReplies.remove(postReply.getId());
670 lock.writeLock().unlock();
679 * Gets all posts for the given Sone, creating a new collection if there is
683 * The ID of the Sone to get the posts for
686 private Collection<Post> getPostsFrom(String soneId) {
687 lock.readLock().lock();
689 return sonePosts.get(soneId);
691 lock.readLock().unlock();
695 /** Loads the known posts. */
696 private void loadKnownPosts() {
697 Set<String> knownPosts = configurationLoader.loadKnownPosts();
698 lock.writeLock().lock();
700 this.knownPosts.clear();
701 this.knownPosts.addAll(knownPosts);
703 lock.writeLock().unlock();
708 * Saves the known posts to the configuration.
710 * @throws DatabaseException
711 * if a configuration error occurs
713 private void saveKnownPosts() throws DatabaseException {
714 lock.readLock().lock();
717 for (String knownPostId : knownPosts) {
718 configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").setValue(knownPostId);
720 configuration.getStringValue("KnownPosts/" + postCounter + "/ID").setValue(null);
721 } catch (ConfigurationException ce1) {
722 throw new DatabaseException("Could not save database.", ce1);
724 lock.readLock().unlock();
728 /** Loads the known post replies. */
729 private void loadKnownPostReplies() {
730 Set<String> knownPostReplies = configurationLoader.loadKnownPostReplies();
731 lock.writeLock().lock();
733 this.knownPostReplies.clear();
734 this.knownPostReplies.addAll(knownPostReplies);
736 lock.writeLock().unlock();
741 * Saves the known post replies to the configuration.
743 * @throws DatabaseException
744 * if a configuration error occurs
746 private void saveKnownPostReplies() throws DatabaseException {
747 lock.readLock().lock();
749 int replyCounter = 0;
750 for (String knownReplyId : knownPostReplies) {
751 configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").setValue(knownReplyId);
753 configuration.getStringValue("KnownReplies/" + replyCounter + "/ID").setValue(null);
754 } catch (ConfigurationException ce1) {
755 throw new DatabaseException("Could not save database.", ce1);
757 lock.readLock().unlock();