2 * FreenetSone - Core.java - Copyright © 2010 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.core;
20 import java.net.MalformedURLException;
21 import java.util.Collections;
22 import java.util.HashMap;
23 import java.util.HashSet;
26 import java.util.UUID;
27 import java.util.logging.Level;
28 import java.util.logging.Logger;
30 import net.pterodactylus.sone.core.SoneException.Type;
31 import net.pterodactylus.sone.data.Post;
32 import net.pterodactylus.sone.data.PostShell;
33 import net.pterodactylus.sone.data.Profile;
34 import net.pterodactylus.sone.data.Reply;
35 import net.pterodactylus.sone.data.ReplyShell;
36 import net.pterodactylus.sone.data.Shell;
37 import net.pterodactylus.sone.data.ShellCache;
38 import net.pterodactylus.sone.data.Sone;
39 import net.pterodactylus.sone.data.SoneShell;
40 import net.pterodactylus.util.config.Configuration;
41 import net.pterodactylus.util.config.ConfigurationException;
42 import net.pterodactylus.util.logging.Logging;
43 import net.pterodactylus.util.service.AbstractService;
44 import freenet.keys.FreenetURI;
49 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
51 public class Core extends AbstractService {
54 private static final Logger logger = Logging.getLogger(Core.class);
56 /** The configuration. */
57 private Configuration configuration;
59 /** Interface to freenet. */
60 private FreenetInterface freenetInterface;
62 /** The local Sones. */
63 private final Set<Sone> localSones = new HashSet<Sone>();
65 /** Sone inserters. */
66 private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
68 /* various caches follow here. */
70 /** Cache for all known Sones. */
71 private final ShellCache<Sone> soneCache = new ShellCache<Sone>(SoneShell.creator);
73 /** Cache for all known posts. */
74 private final ShellCache<Post> postCache = new ShellCache<Post>(PostShell.creator);
76 /** Cache for all known replies. */
77 private final ShellCache<Reply> replyCache = new ShellCache<Reply>(ReplyShell.creator);
91 * Sets the configuration of the core.
93 * @param configuration
94 * The configuration of the core
95 * @return This core (for method chaining)
97 public Core configuration(Configuration configuration) {
98 this.configuration = configuration;
103 * Sets the Freenet interface to use.
105 * @param freenetInterface
106 * The Freenet interface to use
107 * @return This core (for method chaining)
109 public Core freenetInterface(FreenetInterface freenetInterface) {
110 this.freenetInterface = freenetInterface;
115 * Returns the local Sones.
117 * @return The local Sones
119 public Set<Sone> getSones() {
120 return Collections.unmodifiableSet(localSones);
124 * Returns a Sone or a {@link Shell} around one for the given ID.
128 * @return The Sone, or a {@link Shell} around one
130 public Sone getSone(String soneId) {
131 Sone sone = soneCache.get(soneId);
132 if (sone instanceof SoneShell) {
133 soneCache.put(soneId, sone = ((SoneShell) sone).getShelled());
143 * Adds the given Sone.
148 public void addSone(Sone sone) {
149 if (localSones.add(sone)) {
150 soneCache.put(sone.getId(), sone);
151 SoneInserter soneInserter = new SoneInserter(freenetInterface, sone);
152 soneInserter.start();
153 soneInserters.put(sone, soneInserter);
158 * Creates a new Sone at a random location.
161 * The name of the Sone
162 * @return The created Sone
163 * @throws SoneException
164 * if a Sone error occurs
166 public Sone createSone(String name) throws SoneException {
167 return createSone(name, null, null);
171 * Creates a new Sone at the given location. If one of {@code requestUri} or
172 * {@code insertUrI} is {@code null}, the Sone is created at a random
176 * The name of the Sone
178 * The request URI of the Sone, or {@link NullPointerException}
179 * to create a Sone at a random location
181 * The insert URI of the Sone, or {@code null} to create a Sone
182 * at a random location
183 * @return The created Sone
184 * @throws SoneException
185 * if a Sone error occurs
187 public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
188 if ((name == null) || (name.trim().length() == 0)) {
189 throw new SoneException(Type.INVALID_SONE_NAME);
191 String finalRequestUri;
192 String finalInsertUri;
193 if ((requestUri == null) || (insertUri == null)) {
194 String[] keyPair = freenetInterface.generateKeyPair();
195 finalRequestUri = keyPair[0];
196 finalInsertUri = keyPair[1];
198 finalRequestUri = requestUri;
199 finalInsertUri = insertUri;
203 logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
204 sone = new Sone(UUID.randomUUID(), name, new FreenetURI(finalRequestUri).setKeyType("USK"), new FreenetURI(finalInsertUri).setKeyType("USK"));
205 sone.setProfile(new Profile());
206 /* set modification counter to 1 so it is inserted immediately. */
207 sone.setModificationCounter(1);
209 } catch (MalformedURLException mue1) {
210 throw new SoneException(Type.INVALID_URI);
216 * Deletes the given Sone from this plugin instance.
221 public void deleteSone(Sone sone) {
222 SoneInserter soneInserter = soneInserters.remove(sone);
224 localSones.remove(sone);
235 protected void serviceStart() {
243 protected void serviceStop() {
244 /* stop all Sone inserters. */
245 for (SoneInserter soneInserter : soneInserters.values()) {
256 * Loads the configuration.
258 private void loadConfiguration() {
259 logger.entering(Core.class.getName(), "loadConfiguration()");
261 /* parse local Sones. */
262 logger.log(Level.INFO, "Loading Sones…");
265 String sonePrefix = "Sone/Sone." + soneId++;
266 String id = configuration.getStringValue(sonePrefix + "/ID").getValue(null);
270 String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
271 String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
272 String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
273 long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
274 String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
275 String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
276 String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
278 Profile profile = new Profile();
279 profile.setFirstName(firstName);
280 profile.setMiddleName(middleName);
281 profile.setLastName(lastName);
282 Sone sone = new Sone(UUID.fromString(id), name, new FreenetURI(requestUri), new FreenetURI(insertUri));
283 soneCache.put(id, sone);
284 sone.setProfile(profile);
287 String postPrefix = sonePrefix + "/Post." + postId++;
288 id = configuration.getStringValue(postPrefix + "/ID").getValue(null);
292 long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
293 String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
294 Post post = new Post(UUID.fromString(id), sone, time, text);
295 postCache.put(id, post);
298 int replyCounter = 0;
300 String replyPrefix = sonePrefix + "/Reply." + replyCounter++;
301 String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
302 if (replyId == null) {
305 Sone replySone = soneCache.get(configuration.getStringValue(replyPrefix + "/Sone").getValue(null));
306 Post replyPost = postCache.get(configuration.getStringValue(replyPrefix + "/Post").getValue(null));
307 long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue(null);
308 String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
309 Reply reply = new ReplyShell().setSone(replySone).setPost(replyPost).setTime(replyTime).setText(replyText).getShelled();
310 replyCache.put(replyId, reply);
312 sone.setModificationCounter(modificationCounter);
314 } catch (MalformedURLException mue1) {
315 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
318 logger.log(Level.INFO, "Loaded %d Sones.", getSones().size());
320 logger.exiting(Core.class.getName(), "loadConfiguration()");
324 * Saves the configuraiton.
326 private void saveConfiguration() {
327 Set<Sone> sones = getSones();
328 logger.log(Level.INFO, "Storing %d Sones…", sones.size());
330 /* store all Sones. */
332 for (Sone sone : localSones) {
333 String sonePrefix = "Sone/Sone." + soneId++;
334 configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
335 configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
336 configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
337 configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
338 configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
339 Profile profile = sone.getProfile();
340 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
341 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
342 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
344 for (Post post : sone.getPosts()) {
345 String postPrefix = sonePrefix + "/Post." + postId++;
346 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
347 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
348 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
351 for (Reply reply : sone.getReplies()) {
352 String replyPrefix = sonePrefix + "/Reply." + replyId++;
353 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
354 configuration.getStringValue(replyPrefix + "/Sone").setValue(reply.getSone().getId());
355 configuration.getStringValue(replyPrefix + "/Post").setValue(reply.getPost().getId());
356 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
357 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
360 } catch (ConfigurationException ce1) {
361 logger.log(Level.WARNING, "Could not store configuration!", ce1);