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 Sone downloader. */
63 private SoneDownloader soneDownloader;
65 /** The local Sones. */
66 private final Set<Sone> localSones = new HashSet<Sone>();
68 /** Sone inserters. */
69 private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
71 /* various caches follow here. */
73 /** Cache for all known Sones. */
74 private final ShellCache<Sone> soneCache = new ShellCache<Sone>(SoneShell.creator);
76 /** Cache for all known posts. */
77 private final ShellCache<Post> postCache = new ShellCache<Post>(PostShell.creator);
79 /** Cache for all known replies. */
80 private final ShellCache<Reply> replyCache = new ShellCache<Reply>(ReplyShell.creator);
94 * Sets the configuration of the core.
96 * @param configuration
97 * The configuration of the core
98 * @return This core (for method chaining)
100 public Core configuration(Configuration configuration) {
101 this.configuration = configuration;
106 * Sets the Freenet interface to use.
108 * @param freenetInterface
109 * The Freenet interface to use
110 * @return This core (for method chaining)
112 public Core freenetInterface(FreenetInterface freenetInterface) {
113 this.freenetInterface = freenetInterface;
114 soneDownloader = new SoneDownloader(freenetInterface);
119 * Returns the local Sones.
121 * @return The local Sones
123 public Set<Sone> getSones() {
124 return Collections.unmodifiableSet(localSones);
128 * Returns a Sone or a {@link Shell} around one for the given ID.
132 * @return The Sone, or a {@link Shell} around one
134 public Sone getSone(String soneId) {
135 Sone sone = soneCache.get(soneId);
136 if (sone instanceof SoneShell) {
137 soneCache.put(soneId, sone = ((SoneShell) sone).getShelled());
147 * Adds the given Sone.
152 public void addSone(Sone sone) {
153 if (localSones.add(sone)) {
154 soneCache.put(sone.getId(), sone);
155 SoneInserter soneInserter = new SoneInserter(freenetInterface, sone);
156 soneInserter.start();
157 soneDownloader.addSone(sone);
158 soneInserters.put(sone, soneInserter);
163 * Adds a remote Sone so that it is watched for updates.
168 public void addRemoteSone(Sone sone) {
169 Sone updatedSone = soneCache.put(sone.getId(), sone);
170 soneDownloader.addSone(updatedSone);
174 * Creates a new Sone at a random location.
177 * The name of the Sone
178 * @return The created Sone
179 * @throws SoneException
180 * if a Sone error occurs
182 public Sone createSone(String name) throws SoneException {
183 return createSone(name, null, null);
187 * Creates a new Sone at the given location. If one of {@code requestUri} or
188 * {@code insertUrI} is {@code null}, the Sone is created at a random
192 * The name of the Sone
194 * The request URI of the Sone, or {@link NullPointerException}
195 * to create a Sone at a random location
197 * The insert URI of the Sone, or {@code null} to create a Sone
198 * at a random location
199 * @return The created Sone
200 * @throws SoneException
201 * if a Sone error occurs
203 public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
204 if ((name == null) || (name.trim().length() == 0)) {
205 throw new SoneException(Type.INVALID_SONE_NAME);
207 String finalRequestUri;
208 String finalInsertUri;
209 if ((requestUri == null) || (insertUri == null)) {
210 String[] keyPair = freenetInterface.generateKeyPair();
211 finalRequestUri = keyPair[0];
212 finalInsertUri = keyPair[1];
214 finalRequestUri = requestUri;
215 finalInsertUri = insertUri;
219 logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
220 sone = new Sone(UUID.randomUUID(), name, new FreenetURI(finalRequestUri).setKeyType("USK").setDocName("Sone-" + name), new FreenetURI(finalInsertUri).setKeyType("USK").setDocName("Sone-" + name));
221 sone.setProfile(new Profile());
222 /* set modification counter to 1 so it is inserted immediately. */
223 sone.setModificationCounter(1);
225 } catch (MalformedURLException mue1) {
226 throw new SoneException(Type.INVALID_URI);
232 * Deletes the given Sone from this plugin instance.
237 public void deleteSone(Sone sone) {
238 SoneInserter soneInserter = soneInserters.remove(sone);
240 localSones.remove(sone);
251 protected void serviceStart() {
259 protected void serviceStop() {
260 soneDownloader.stop();
261 /* stop all Sone inserters. */
262 for (SoneInserter soneInserter : soneInserters.values()) {
273 * Loads the configuration.
275 private void loadConfiguration() {
276 logger.entering(Core.class.getName(), "loadConfiguration()");
278 /* parse local Sones. */
279 logger.log(Level.INFO, "Loading Sones…");
282 String sonePrefix = "Sone/Sone." + soneId++;
283 String id = configuration.getStringValue(sonePrefix + "/ID").getValue(null);
287 String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
288 String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
289 String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
290 long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
291 String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
292 String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
293 String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
295 Profile profile = new Profile();
296 profile.setFirstName(firstName);
297 profile.setMiddleName(middleName);
298 profile.setLastName(lastName);
299 Sone sone = new Sone(UUID.fromString(id), name, new FreenetURI(requestUri), new FreenetURI(insertUri));
300 soneCache.put(id, sone);
301 sone.setProfile(profile);
304 String postPrefix = sonePrefix + "/Post." + postId++;
305 id = configuration.getStringValue(postPrefix + "/ID").getValue(null);
309 long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
310 String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
311 Post post = new Post(UUID.fromString(id), sone, time, text);
312 postCache.put(id, post);
315 int replyCounter = 0;
317 String replyPrefix = sonePrefix + "/Reply." + replyCounter++;
318 String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
319 if (replyId == null) {
322 Sone replySone = soneCache.get(configuration.getStringValue(replyPrefix + "/Sone/ID").getValue(null));
323 String replySoneKey = configuration.getStringValue(replyPrefix + "/Sone/Key").getValue(null);
324 String replySoneName = configuration.getStringValue(replyPrefix + "/Sone/Name").getValue(null);
325 if (replySone instanceof SoneShell) {
326 ((SoneShell) replySone).setRequestUri(new FreenetURI(replySoneKey)).setName(replySoneName);
328 Post replyPost = postCache.get(configuration.getStringValue(replyPrefix + "/Post").getValue(null));
329 long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue(null);
330 String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
331 Reply reply = new ReplyShell().setSone(replySone).setPost(replyPost).setTime(replyTime).setText(replyText).getShelled();
332 replyCache.put(replyId, reply);
336 int friendCounter = 0;
338 String friendPrefix = sonePrefix + "/Friend." + friendCounter++;
339 String friendId = configuration.getStringValue(friendPrefix + "/ID").getValue(null);
340 if (friendId == null) {
343 Sone friendSone = soneCache.get(friendId);
344 if (friendSone instanceof SoneShell) {
345 String friendKey = configuration.getStringValue(friendPrefix + "/Key").getValue(null);
346 String friendName = configuration.getStringValue(friendPrefix + "/Name").getValue(null);
347 ((SoneShell) friendSone).setRequestUri(new FreenetURI(friendKey)).setName(friendName);
349 addRemoteSone(friendSone);
350 sone.addFriendSone(sone);
353 sone.setModificationCounter(modificationCounter);
355 } catch (MalformedURLException mue1) {
356 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
359 logger.log(Level.INFO, "Loaded %d Sones.", getSones().size());
361 logger.exiting(Core.class.getName(), "loadConfiguration()");
365 * Saves the configuraiton.
367 private void saveConfiguration() {
368 Set<Sone> sones = getSones();
369 logger.log(Level.INFO, "Storing %d Sones…", sones.size());
371 /* store all Sones. */
373 for (Sone sone : localSones) {
374 String sonePrefix = "Sone/Sone." + soneId++;
375 configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
376 configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
377 configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
378 configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
379 configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
380 Profile profile = sone.getProfile();
381 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
382 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
383 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
385 for (Post post : sone.getPosts()) {
386 String postPrefix = sonePrefix + "/Post." + postId++;
387 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
388 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
389 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
391 /* write null ID as terminator. */
392 configuration.getStringValue(sonePrefix + "/Post." + postId + "/ID").setValue(null);
395 for (Reply reply : sone.getReplies()) {
396 String replyPrefix = sonePrefix + "/Reply." + replyId++;
397 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
398 configuration.getStringValue(replyPrefix + "/Sone/ID").setValue(reply.getSone().getId());
399 configuration.getStringValue(replyPrefix + "/Sone/Key").setValue(reply.getSone().getRequestUri().toString());
400 configuration.getStringValue(replyPrefix + "/Sone/Name").setValue(reply.getSone().getName());
401 configuration.getStringValue(replyPrefix + "/Post").setValue(reply.getPost().getId());
402 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
403 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
405 /* write null ID as terminator. */
406 configuration.getStringValue(sonePrefix + "/Reply." + replyId + "/ID").setValue(null);
409 for (Sone friend : sone.getFriendSones()) {
410 String friendPrefix = sonePrefix + "/Friend." + friendId++;
411 configuration.getStringValue(friendPrefix + "/ID").setValue(friend.getId());
412 configuration.getStringValue(friendPrefix + "/Key").setValue(friend.getRequestUri().toString());
413 configuration.getStringValue(friendPrefix + "/Name").setValue(friend.getName());
415 /* write null ID as terminator. */
416 configuration.getStringValue(sonePrefix + "/Friend." + friendId + "/ID").setValue(null);
419 /* write null ID as terminator. */
420 configuration.getStringValue("Sone/Sone." + soneId + "/ID").setValue(null);
422 } catch (ConfigurationException ce1) {
423 logger.log(Level.WARNING, "Could not store configuration!", ce1);