2 * Sone - MemoryDatabase.java - Copyright © 2013 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 java.util.Collections.emptyList;
25 import static net.pterodactylus.sone.data.Sone.LOCAL_SONE_FILTER;
27 import java.util.ArrayList;
28 import java.util.Collection;
29 import java.util.Collections;
30 import java.util.Comparator;
31 import java.util.HashMap;
32 import java.util.HashSet;
33 import java.util.List;
36 import java.util.SortedSet;
37 import java.util.TreeSet;
38 import java.util.concurrent.locks.ReadWriteLock;
39 import java.util.concurrent.locks.ReentrantReadWriteLock;
41 import net.pterodactylus.sone.data.Album;
42 import net.pterodactylus.sone.data.Image;
43 import net.pterodactylus.sone.data.Post;
44 import net.pterodactylus.sone.data.PostReply;
45 import net.pterodactylus.sone.data.Reply;
46 import net.pterodactylus.sone.data.Sone;
47 import net.pterodactylus.sone.database.Database;
48 import net.pterodactylus.sone.database.DatabaseException;
49 import net.pterodactylus.sone.database.PostBuilder;
50 import net.pterodactylus.sone.database.PostDatabase;
51 import net.pterodactylus.sone.database.PostReplyBuilder;
52 import net.pterodactylus.sone.database.SoneBuilder;
53 import net.pterodactylus.util.config.Configuration;
54 import net.pterodactylus.util.config.ConfigurationException;
56 import com.google.common.base.Function;
57 import com.google.common.base.Optional;
58 import com.google.common.collect.ArrayListMultimap;
59 import com.google.common.collect.ListMultimap;
60 import com.google.common.collect.SortedSetMultimap;
61 import com.google.common.collect.TreeMultimap;
62 import com.google.common.util.concurrent.AbstractService;
63 import com.google.inject.Inject;
66 * Memory-based {@link PostDatabase} implementation.
68 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
70 public class MemoryDatabase extends AbstractService implements Database {
73 private final ReadWriteLock lock = new ReentrantReadWriteLock();
75 /** The configuration. */
76 private final Configuration configuration;
78 private final Map<String, Sone> sones = new HashMap<String, Sone>();
80 /** All posts by their ID. */
81 private final Map<String, Post> allPosts = new HashMap<String, Post>();
83 /** All posts by their Sones. */
84 private final Map<String, Collection<Post>> sonePosts = new HashMap<String, Collection<Post>>();
86 /** All posts by their recipient. */
87 private final Map<String, Collection<Post>> recipientPosts = new HashMap<String, Collection<Post>>();
89 /** Whether posts are known. */
90 private final Set<String> knownPosts = new HashSet<String>();
92 /** All post replies by their ID. */
93 private final Map<String, PostReply> allPostReplies = new HashMap<String, PostReply>();
95 /** Replies sorted by Sone. */
96 private final SortedSetMultimap<String, PostReply> sonePostReplies = TreeMultimap.create(new Comparator<String>() {
99 public int compare(String leftString, String rightString) {
100 return leftString.compareTo(rightString);
102 }, PostReply.TIME_COMPARATOR);
104 /** Replies by post. */
105 private final Map<String, SortedSet<PostReply>> postReplies = new HashMap<String, SortedSet<PostReply>>();
107 /** Whether post replies are known. */
108 private final Set<String> knownPostReplies = new HashSet<String>();
110 private final Map<String, Album> allAlbums = new HashMap<String, Album>();
111 private final ListMultimap<String, String> albumChildren = ArrayListMultimap.create();
112 private final ListMultimap<String, String> albumImages = ArrayListMultimap.create();
114 private final Map<String, Image> allImages = new HashMap<String, Image>();
117 * Creates a new memory database.
119 * @param configuration
120 * The configuration for loading and saving elements
123 public MemoryDatabase(Configuration configuration) {
124 this.configuration = configuration;
132 * Saves the database.
134 * @throws DatabaseException
135 * if an error occurs while saving
138 public void save() throws DatabaseException {
140 saveKnownPostReplies();
147 /** {@inheritDocs} */
149 protected void doStart() {
151 loadKnownPostReplies();
155 /** {@inheritDocs} */
157 protected void doStop() {
161 } catch (DatabaseException de1) {
167 public Optional<Sone> getSone(String soneId) {
168 lock.readLock().lock();
170 return fromNullable(sones.get(soneId));
172 lock.readLock().unlock();
177 public Collection<Sone> getSones() {
178 lock.readLock().lock();
180 return Collections.unmodifiableCollection(sones.values());
182 lock.readLock().unlock();
187 public Collection<Sone> getLocalSones() {
188 lock.readLock().lock();
190 return from(getSones()).filter(LOCAL_SONE_FILTER).toSet();
192 lock.readLock().unlock();
197 public Collection<Sone> getRemoteSones() {
198 lock.readLock().lock();
200 return from(getSones()).filter(not(LOCAL_SONE_FILTER)).toSet();
202 lock.readLock().unlock();
207 public SoneBuilder newSoneBuilder() {
212 // POSTPROVIDER METHODS
215 /** {@inheritDocs} */
217 public Optional<Post> getPost(String postId) {
218 lock.readLock().lock();
220 return fromNullable(allPosts.get(postId));
222 lock.readLock().unlock();
226 /** {@inheritDocs} */
228 public Collection<Post> getPosts(String soneId) {
229 return new HashSet<Post>(getPostsFrom(soneId));
232 /** {@inheritDocs} */
234 public Collection<Post> getDirectedPosts(String recipientId) {
235 lock.readLock().lock();
237 Collection<Post> posts = recipientPosts.get(recipientId);
238 return (posts == null) ? Collections.<Post>emptySet() : new HashSet<Post>(posts);
240 lock.readLock().unlock();
248 /** {@inheritDocs} */
250 public void storePost(Post post) {
251 checkNotNull(post, "post must not be null");
252 lock.writeLock().lock();
254 allPosts.put(post.getId(), post);
255 getPostsFrom(post.getSone().getId()).add(post);
256 if (post.getRecipientId().isPresent()) {
257 getPostsTo(post.getRecipientId().get()).add(post);
260 lock.writeLock().unlock();
264 /** {@inheritDocs} */
266 public void removePost(Post post) {
267 checkNotNull(post, "post must not be null");
268 lock.writeLock().lock();
270 allPosts.remove(post.getId());
271 getPostsFrom(post.getSone().getId()).remove(post);
272 if (post.getRecipientId().isPresent()) {
273 getPostsTo(post.getRecipientId().get()).remove(post);
275 post.getSone().removePost(post);
277 lock.writeLock().unlock();
281 /** {@inheritDocs} */
283 public void storePosts(Sone sone, Collection<Post> posts) throws IllegalArgumentException {
284 checkNotNull(sone, "sone must not be null");
285 /* verify that all posts are from the same Sone. */
286 for (Post post : posts) {
287 if (!sone.equals(post.getSone())) {
288 throw new IllegalArgumentException(String.format("Post from different Sone found: %s", post));
292 lock.writeLock().lock();
294 /* remove all posts by the Sone. */
295 getPostsFrom(sone.getId()).clear();
296 for (Post post : posts) {
297 allPosts.remove(post.getId());
298 if (post.getRecipientId().isPresent()) {
299 getPostsTo(post.getRecipientId().get()).remove(post);
304 getPostsFrom(sone.getId()).addAll(posts);
305 for (Post post : posts) {
306 allPosts.put(post.getId(), post);
307 if (post.getRecipientId().isPresent()) {
308 getPostsTo(post.getRecipientId().get()).add(post);
312 lock.writeLock().unlock();
316 /** {@inheritDocs} */
318 public void removePosts(Sone sone) {
319 checkNotNull(sone, "sone must not be null");
320 lock.writeLock().lock();
322 /* remove all posts by the Sone. */
323 getPostsFrom(sone.getId()).clear();
324 for (Post post : sone.getPosts()) {
325 allPosts.remove(post.getId());
326 if (post.getRecipientId().isPresent()) {
327 getPostsTo(post.getRecipientId().get()).remove(post);
331 lock.writeLock().unlock();
336 // POSTREPLYPROVIDER METHODS
339 /** {@inheritDocs} */
341 public Optional<PostReply> getPostReply(String id) {
342 lock.readLock().lock();
344 return fromNullable(allPostReplies.get(id));
346 lock.readLock().unlock();
350 /** {@inheritDocs} */
352 public List<PostReply> getReplies(String postId) {
353 lock.readLock().lock();
355 if (!postReplies.containsKey(postId)) {
358 return new ArrayList<PostReply>(postReplies.get(postId));
360 lock.readLock().unlock();
365 // POSTREPLYBUILDERFACTORY METHODS
368 /** {@inheritDocs} */
370 public PostReplyBuilder newPostReplyBuilder() {
371 return new MemoryPostReplyBuilder(this, this);
375 // POSTREPLYSTORE METHODS
378 /** {@inheritDocs} */
380 public void storePostReply(PostReply postReply) {
381 lock.writeLock().lock();
383 allPostReplies.put(postReply.getId(), postReply);
384 if (postReplies.containsKey(postReply.getPostId())) {
385 postReplies.get(postReply.getPostId()).add(postReply);
387 TreeSet<PostReply> replies = new TreeSet<PostReply>(Reply.TIME_COMPARATOR);
388 replies.add(postReply);
389 postReplies.put(postReply.getPostId(), replies);
392 lock.writeLock().unlock();
396 /** {@inheritDocs} */
398 public void storePostReplies(Sone sone, Collection<PostReply> postReplies) {
399 checkNotNull(sone, "sone must not be null");
400 /* verify that all posts are from the same Sone. */
401 for (PostReply postReply : postReplies) {
402 if (!sone.equals(postReply.getSone())) {
403 throw new IllegalArgumentException(String.format("PostReply from different Sone found: %s", postReply));
407 lock.writeLock().lock();
409 /* remove all post replies of the Sone. */
410 for (PostReply postReply : getRepliesFrom(sone.getId())) {
411 removePostReply(postReply);
413 for (PostReply postReply : postReplies) {
414 allPostReplies.put(postReply.getId(), postReply);
415 sonePostReplies.put(postReply.getSone().getId(), postReply);
416 if (this.postReplies.containsKey(postReply.getPostId())) {
417 this.postReplies.get(postReply.getPostId()).add(postReply);
419 TreeSet<PostReply> replies = new TreeSet<PostReply>(Reply.TIME_COMPARATOR);
420 replies.add(postReply);
421 this.postReplies.put(postReply.getPostId(), replies);
425 lock.writeLock().unlock();
429 /** {@inheritDocs} */
431 public void removePostReply(PostReply postReply) {
432 lock.writeLock().lock();
434 allPostReplies.remove(postReply.getId());
435 if (postReplies.containsKey(postReply.getPostId())) {
436 postReplies.get(postReply.getPostId()).remove(postReply);
437 if (postReplies.get(postReply.getPostId()).isEmpty()) {
438 postReplies.remove(postReply.getPostId());
442 lock.writeLock().unlock();
446 /** {@inheritDocs} */
448 public void removePostReplies(Sone sone) {
449 checkNotNull(sone, "sone must not be null");
451 lock.writeLock().lock();
453 for (PostReply postReply : sone.getReplies()) {
454 removePostReply(postReply);
457 lock.writeLock().unlock();
462 // ALBUMPROVDER METHODS
466 public Optional<Album> getAlbum(String albumId) {
467 lock.readLock().lock();
469 return fromNullable(allAlbums.get(albumId));
471 lock.readLock().unlock();
476 public List<Album> getAlbums(Album parent) {
477 lock.readLock().lock();
479 return from(albumChildren.get(parent.getId())).transformAndConcat(getAlbum()).toList();
481 lock.readLock().unlock();
486 public void moveUp(Album album) {
487 lock.writeLock().lock();
489 List<String> albums = albumChildren.get(album.getParent().getId());
490 int currentIndex = albums.indexOf(album.getId());
491 if (currentIndex == 0) {
494 albums.remove(album.getId());
495 albums.add(currentIndex - 1, album.getId());
497 lock.writeLock().unlock();
502 public void moveDown(Album album) {
503 lock.writeLock().lock();
505 List<String> albums = albumChildren.get(album.getParent().getId());
506 int currentIndex = albums.indexOf(album.getId());
507 if (currentIndex == (albums.size() - 1)) {
510 albums.remove(album.getId());
511 albums.add(currentIndex + 1, album.getId());
513 lock.writeLock().unlock();
518 // ALBUMSTORE METHODS
522 public void storeAlbum(Album album) {
523 lock.writeLock().lock();
525 allAlbums.put(album.getId(), album);
526 albumChildren.put(album.getParent().getId(), album.getId());
528 lock.writeLock().unlock();
533 public void removeAlbum(Album album) {
534 lock.writeLock().lock();
536 allAlbums.remove(album.getId());
537 albumChildren.remove(album.getParent().getId(), album.getId());
539 lock.writeLock().unlock();
544 // IMAGEPROVIDER METHODS
548 public Optional<Image> getImage(String imageId) {
549 lock.readLock().lock();
551 return fromNullable(allImages.get(imageId));
553 lock.readLock().unlock();
558 public List<Image> getImages(Album parent) {
559 lock.readLock().lock();
561 return from(albumImages.get(parent.getId())).transformAndConcat(getImage()).toList();
563 lock.readLock().unlock();
568 public void moveUp(Image image) {
569 lock.writeLock().lock();
571 List<String> images = albumImages.get(image.getAlbum().getId());
572 int currentIndex = images.indexOf(image.getId());
573 if (currentIndex == 0) {
576 images.remove(image.getId());
577 images.add(currentIndex - 1, image.getId());
579 lock.writeLock().unlock();
584 public void moveDown(Image image) {
585 lock.writeLock().lock();
587 List<String> images = albumChildren.get(image.getAlbum().getId());
588 int currentIndex = images.indexOf(image.getId());
589 if (currentIndex == (images.size() - 1)) {
592 images.remove(image.getId());
593 images.add(currentIndex + 1, image.getId());
595 lock.writeLock().unlock();
600 // IMAGESTORE METHODS
604 public void storeImage(Image image) {
605 lock.writeLock().lock();
607 allImages.put(image.getId(), image);
608 albumImages.put(image.getAlbum().getId(), image.getId());
610 lock.writeLock().unlock();
615 public void removeImage(Image image) {
616 lock.writeLock().lock();
618 allImages.remove(image.getId());
619 albumImages.remove(image.getAlbum().getId(), image.getId());
621 lock.writeLock().unlock();
626 // PACKAGE-PRIVATE METHODS
630 * Returns whether the given post is known.
634 * @return {@code true} if the post is known, {@code false} otherwise
636 boolean isPostKnown(Post post) {
637 lock.readLock().lock();
639 return knownPosts.contains(post.getId());
641 lock.readLock().unlock();
646 * Sets whether the given post is known.
651 * {@code true} if the post is known, {@code false} otherwise
653 void setPostKnown(Post post, boolean known) {
654 lock.writeLock().lock();
657 knownPosts.add(post.getId());
659 knownPosts.remove(post.getId());
662 lock.writeLock().unlock();
667 * Returns whether the given post reply is known.
671 * @return {@code true} if the given post reply is known, {@code false}
674 boolean isPostReplyKnown(PostReply postReply) {
675 lock.readLock().lock();
677 return knownPostReplies.contains(postReply.getId());
679 lock.readLock().unlock();
684 * Sets whether the given post reply is known.
689 * {@code true} if the post reply is known, {@code false} otherwise
691 void setPostReplyKnown(PostReply postReply, boolean known) {
692 lock.writeLock().lock();
695 knownPostReplies.add(postReply.getId());
697 knownPostReplies.remove(postReply.getId());
700 lock.writeLock().unlock();
709 * Gets all posts for the given Sone, creating a new collection if there is
713 * The ID of the Sone to get the posts for
716 private Collection<Post> getPostsFrom(String soneId) {
717 Collection<Post> posts = null;
718 lock.readLock().lock();
720 posts = sonePosts.get(soneId);
722 lock.readLock().unlock();
728 posts = new HashSet<Post>();
729 lock.writeLock().lock();
731 sonePosts.put(soneId, posts);
733 lock.writeLock().unlock();
740 * Gets all posts that are directed the given Sone, creating a new collection
741 * if there is none yet.
744 * The ID of the Sone to get the posts for
747 private Collection<Post> getPostsTo(String recipientId) {
748 Collection<Post> posts = null;
749 lock.readLock().lock();
751 posts = recipientPosts.get(recipientId);
753 lock.readLock().unlock();
759 posts = new HashSet<Post>();
760 lock.writeLock().lock();
762 recipientPosts.put(recipientId, posts);
764 lock.writeLock().unlock();
770 /** Loads the known posts. */
771 private void loadKnownPosts() {
772 lock.writeLock().lock();
776 String knownPostId = configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").getValue(null);
777 if (knownPostId == null) {
780 knownPosts.add(knownPostId);
783 lock.writeLock().unlock();
788 * Saves the known posts to the configuration.
790 * @throws DatabaseException
791 * if a configuration error occurs
793 private void saveKnownPosts() throws DatabaseException {
794 lock.readLock().lock();
797 for (String knownPostId : knownPosts) {
798 configuration.getStringValue("KnownPosts/" + postCounter++ + "/ID").setValue(knownPostId);
800 configuration.getStringValue("KnownPosts/" + postCounter + "/ID").setValue(null);
801 } catch (ConfigurationException ce1) {
802 throw new DatabaseException("Could not save database.", ce1);
804 lock.readLock().unlock();
809 * Returns all replies by the given Sone.
813 * @return The post replies of the Sone, sorted by time (newest first)
815 private Collection<PostReply> getRepliesFrom(String id) {
816 lock.readLock().lock();
818 if (sonePostReplies.containsKey(id)) {
819 return Collections.unmodifiableCollection(sonePostReplies.get(id));
821 return Collections.emptySet();
823 lock.readLock().unlock();
827 /** Loads the known post replies. */
828 private void loadKnownPostReplies() {
829 lock.writeLock().lock();
831 int replyCounter = 0;
833 String knownReplyId = configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").getValue(null);
834 if (knownReplyId == null) {
837 knownPostReplies.add(knownReplyId);
840 lock.writeLock().unlock();
845 * Saves the known post replies to the configuration.
847 * @throws DatabaseException
848 * if a configuration error occurs
850 private void saveKnownPostReplies() throws DatabaseException {
851 lock.readLock().lock();
853 int replyCounter = 0;
854 for (String knownReplyId : knownPostReplies) {
855 configuration.getStringValue("KnownReplies/" + replyCounter++ + "/ID").setValue(knownReplyId);
857 configuration.getStringValue("KnownReplies/" + replyCounter + "/ID").setValue(null);
858 } catch (ConfigurationException ce1) {
859 throw new DatabaseException("Could not save database.", ce1);
861 lock.readLock().unlock();
865 private Function<String, Iterable<Album>> getAlbum() {
866 return new Function<String, Iterable<Album>>() {
868 public Iterable<Album> apply(String input) {
869 return (input == null) ? Collections.<Album>emptyList() : getAlbum(input).asSet();
874 private Function<String, Iterable<Image>> getImage() {
875 return new Function<String, Iterable<Image>>() {
877 public Iterable<Image> apply(String input) {
878 return (input == null) ? Collections.<Image>emptyList() : getImage(input).asSet();