🎨 Declare return value for ticker explicitely
[Sone.git] / src / main / java / net / pterodactylus / sone / core / ImageInserter.java
1 /*
2  * Sone - ImageInserter.java - Copyright Â© 2011–2019 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.core;
19
20 import static com.google.common.base.Preconditions.checkArgument;
21 import static com.google.common.base.Preconditions.checkNotNull;
22 import static java.util.logging.Logger.getLogger;
23
24 import java.util.Collections;
25 import java.util.HashMap;
26 import java.util.Map;
27 import java.util.logging.Level;
28 import java.util.logging.Logger;
29
30 import javax.inject.Inject;
31
32 import net.pterodactylus.sone.core.FreenetInterface.InsertToken;
33 import net.pterodactylus.sone.core.FreenetInterface.InsertTokenSupplier;
34 import net.pterodactylus.sone.data.Image;
35 import net.pterodactylus.sone.data.TemporaryImage;
36
37 import com.google.common.base.Function;
38
39 /**
40  * The image inserter is responsible for inserting images using
41  * {@link FreenetInterface#insertImage(TemporaryImage, Image, InsertToken)} and
42  * also tracks running inserts, giving the possibility to abort a running
43  * insert.
44  */
45 public class ImageInserter {
46
47         /** The logger. */
48         private static final Logger logger = getLogger(ImageInserter.class.getName());
49
50         /** The freenet interface. */
51         private final FreenetInterface freenetInterface;
52         private final Function<Image, InsertToken> insertTokenSupplier;
53
54         /** The tokens of running inserts. */
55         private final Map<String, InsertToken> insertTokens = Collections.synchronizedMap(new HashMap<String, InsertToken>());
56
57         /**
58          * Creates a new image inserter.
59          *
60          * @param freenetInterface
61          *            The freenet interface
62          * @param insertTokenSupplier
63          *            The supplier for insert tokens
64          */
65         @Inject
66         public ImageInserter(FreenetInterface freenetInterface, InsertTokenSupplier insertTokenSupplier) {
67                 this.freenetInterface = freenetInterface;
68                 this.insertTokenSupplier = insertTokenSupplier;
69         }
70
71         /**
72          * Inserts the given image.
73          *
74          * @param temporaryImage
75          *            The temporary image data
76          * @param image
77          *            The image
78          */
79         public void insertImage(TemporaryImage temporaryImage, Image image) {
80                 checkNotNull(temporaryImage, "temporaryImage must not be null");
81                 checkNotNull(image, "image must not be null");
82                 checkArgument(image.getId().equals(temporaryImage.getId()), "image IDs must match");
83                 try {
84                         InsertToken insertToken = insertTokenSupplier.apply(image);
85                         insertTokens.put(image.getId(), insertToken);
86                         freenetInterface.insertImage(temporaryImage, image, insertToken);
87                 } catch (SoneException se1) {
88                         logger.log(Level.WARNING, "Could not insert image!", se1);
89                 }
90         }
91
92         /**
93          * Cancels a running image insert. If no insert is running for the given
94          * image, nothing happens.
95          *
96          * @param image
97          *            The image being inserted
98          */
99         public void cancelImageInsert(Image image) {
100                 InsertToken insertToken = insertTokens.remove(image.getId());
101                 if (insertToken == null) {
102                         return;
103                 }
104                 insertToken.cancel();
105         }
106
107 }