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.ArrayList;
22 import java.util.Collections;
23 import java.util.Comparator;
24 import java.util.HashMap;
25 import java.util.HashSet;
26 import java.util.List;
29 import java.util.UUID;
30 import java.util.logging.Level;
31 import java.util.logging.Logger;
33 import net.pterodactylus.sone.core.SoneException.Type;
34 import net.pterodactylus.sone.data.Post;
35 import net.pterodactylus.sone.data.Profile;
36 import net.pterodactylus.sone.data.Reply;
37 import net.pterodactylus.sone.data.Sone;
38 import net.pterodactylus.util.config.Configuration;
39 import net.pterodactylus.util.config.ConfigurationException;
40 import net.pterodactylus.util.logging.Logging;
41 import net.pterodactylus.util.service.AbstractService;
42 import freenet.keys.FreenetURI;
47 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
49 public class Core extends AbstractService {
52 private static final Logger logger = Logging.getLogger(Core.class);
54 /** The configuration. */
55 private Configuration configuration;
57 /** Interface to freenet. */
58 private FreenetInterface freenetInterface;
60 /** The Sone downloader. */
61 private SoneDownloader soneDownloader;
63 /** The local Sones. */
64 private final Set<Sone> localSones = new HashSet<Sone>();
66 /** Sone inserters. */
67 private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
69 /* various caches follow here. */
71 /** Cache for all known Sones. */
72 private final Map<String, Sone> soneCache = new HashMap<String, Sone>();
74 /** Cache for all known posts. */
75 private final Map<String, Post> postCache = new HashMap<String, Post>();
77 /** Cache for all known replies. */
78 private final Map<String, Reply> replyCache = new HashMap<String, Reply>();
92 * Sets the configuration of the core.
94 * @param configuration
95 * The configuration of the core
96 * @return This core (for method chaining)
98 public Core configuration(Configuration configuration) {
99 this.configuration = configuration;
104 * Sets the Freenet interface to use.
106 * @param freenetInterface
107 * The Freenet interface to use
108 * @return This core (for method chaining)
110 public Core freenetInterface(FreenetInterface freenetInterface) {
111 this.freenetInterface = freenetInterface;
112 soneDownloader = new SoneDownloader(this, freenetInterface);
113 soneDownloader.start();
118 * Returns the local Sones.
120 * @return The local Sones
122 public Set<Sone> getSones() {
123 return Collections.unmodifiableSet(localSones);
127 * Returns the Sone with the given ID, or an empty Sone that has been
128 * initialized with the given ID.
134 public Sone getSone(String soneId) {
135 if (!soneCache.containsKey(soneId)) {
136 Sone sone = new Sone(soneId);
137 soneCache.put(soneId, sone);
139 return soneCache.get(soneId);
143 * Creates a new post.
146 * The sone that creates the post
148 * The text of the post
149 * @return The created post
151 public Post createPost(Sone sone, String text) {
152 return createPost(sone, System.currentTimeMillis(), text);
156 * Creates a new post.
159 * The Sone that creates the post
161 * The time of the post
163 * The text of the post
164 * @return The created post
166 public Post createPost(Sone sone, long time, String text) {
167 return getPost(UUID.randomUUID().toString()).setSone(sone).setTime(time).setText(text);
175 * Adds the given Sone.
180 public void addLocalSone(Sone sone) {
181 if (localSones.add(sone)) {
182 SoneInserter soneInserter = new SoneInserter(freenetInterface, sone);
183 soneInserter.start();
184 soneDownloader.addSone(sone);
185 soneInserters.put(sone, soneInserter);
190 * Creates a new Sone at a random location.
193 * The name of the Sone
194 * @return The created Sone
195 * @throws SoneException
196 * if a Sone error occurs
198 public Sone createSone(String name) throws SoneException {
199 return createSone(name, null, null);
203 * Creates a new Sone at the given location. If one of {@code requestUri} or
204 * {@code insertUrI} is {@code null}, the Sone is created at a random
208 * The name of the Sone
210 * The request URI of the Sone, or {@link NullPointerException}
211 * to create a Sone at a random location
213 * The insert URI of the Sone, or {@code null} to create a Sone
214 * at a random location
215 * @return The created Sone
216 * @throws SoneException
217 * if a Sone error occurs
219 public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
220 if ((name == null) || (name.trim().length() == 0)) {
221 throw new SoneException(Type.INVALID_SONE_NAME);
223 String finalRequestUri;
224 String finalInsertUri;
225 if ((requestUri == null) || (insertUri == null)) {
226 String[] keyPair = freenetInterface.generateKeyPair();
227 finalRequestUri = keyPair[0];
228 finalInsertUri = keyPair[1];
230 finalRequestUri = requestUri;
231 finalInsertUri = insertUri;
235 logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
236 sone = getSone(UUID.randomUUID().toString()).setName(name).setRequestUri(new FreenetURI(finalRequestUri).setKeyType("USK").setDocName("Sone-" + name)).setInsertUri(new FreenetURI(finalInsertUri).setKeyType("USK").setDocName("Sone-" + name));
237 sone.setProfile(new Profile());
238 /* set modification counter to 1 so it is inserted immediately. */
239 sone.setModificationCounter(1);
241 } catch (MalformedURLException mue1) {
242 throw new SoneException(Type.INVALID_URI);
248 * Deletes the given Sone from this plugin instance.
253 public void deleteSone(Sone sone) {
254 SoneInserter soneInserter = soneInserters.remove(sone);
256 localSones.remove(sone);
260 * Returns the post with the given ID. If no post exists yet with the given
261 * ID, a new post is returned.
267 public Post getPost(String postId) {
268 if (!postCache.containsKey(postId)) {
269 postCache.put(postId, new Post(postId));
271 return postCache.get(postId);
275 * Returns the reply with the given ID. If no reply exists yet with the
276 * given ID, a new reply is returned.
279 * The ID of the reply
282 public Reply getReply(String replyId) {
283 if (!replyCache.containsKey(replyId)) {
284 replyCache.put(replyId, new Reply(replyId));
286 return replyCache.get(replyId);
290 * Gets all replies to the given post, sorted by date, oldest first.
293 * The post the replies refer to
294 * @return The sorted list of replies for the post
296 public List<Reply> getReplies(Post post) {
297 List<Reply> replies = new ArrayList<Reply>();
298 for (Reply reply : replyCache.values()) {
299 if (reply.getPost().equals(post)) {
303 Collections.sort(replies, new Comparator<Reply>() {
309 public int compare(Reply leftReply, Reply rightReply) {
310 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
324 protected void serviceStart() {
332 protected void serviceStop() {
333 soneDownloader.stop();
334 /* stop all Sone inserters. */
335 for (SoneInserter soneInserter : soneInserters.values()) {
346 * Loads the configuration.
348 private void loadConfiguration() {
349 logger.entering(Core.class.getName(), "loadConfiguration()");
351 /* parse local Sones. */
352 logger.log(Level.INFO, "Loading Sones…");
355 String sonePrefix = "Sone/Sone." + soneId++;
356 String id = configuration.getStringValue(sonePrefix + "/ID").getValue(null);
360 String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
361 String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
362 String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
363 long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
364 String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
365 String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
366 String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
368 Profile profile = new Profile();
369 profile.setFirstName(firstName);
370 profile.setMiddleName(middleName);
371 profile.setLastName(lastName);
372 Sone sone = getSone(id).setName(name).setRequestUri(new FreenetURI(requestUri)).setInsertUri(new FreenetURI(insertUri));
373 sone.setProfile(profile);
376 String postPrefix = sonePrefix + "/Post." + postId++;
377 id = configuration.getStringValue(postPrefix + "/ID").getValue(null);
381 long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
382 String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
383 Post post = getPost(id).setSone(sone).setTime(time).setText(text);
386 int replyCounter = 0;
388 String replyPrefix = sonePrefix + "/Reply." + replyCounter++;
389 String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
390 if (replyId == null) {
393 Post replyPost = getPost(configuration.getStringValue(replyPrefix + "/Post").getValue(null));
394 long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue(null);
395 String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
396 Reply reply = getReply(replyId).setSone(sone).setPost(replyPost).setTime(replyTime).setText(replyText);
397 sone.addReply(reply);
401 int friendCounter = 0;
403 String friendPrefix = sonePrefix + "/Friend." + friendCounter++;
404 String friendId = configuration.getStringValue(friendPrefix + "/ID").getValue(null);
405 if (friendId == null) {
408 Sone friendSone = getSone(friendId);
409 String friendKey = configuration.getStringValue(friendPrefix + "/Key").getValue(null);
410 String friendName = configuration.getStringValue(friendPrefix + "/Name").getValue(null);
411 friendSone.setRequestUri(new FreenetURI(friendKey)).setName(friendName);
412 soneDownloader.addSone(friendSone);
413 sone.addFriend(friendSone);
416 sone.setModificationCounter(modificationCounter);
418 } catch (MalformedURLException mue1) {
419 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
422 logger.log(Level.INFO, "Loaded %d Sones.", getSones().size());
424 logger.exiting(Core.class.getName(), "loadConfiguration()");
428 * Saves the configuraiton.
430 private void saveConfiguration() {
431 Set<Sone> sones = getSones();
432 logger.log(Level.INFO, "Storing %d Sones…", sones.size());
434 /* store all Sones. */
436 for (Sone sone : localSones) {
437 String sonePrefix = "Sone/Sone." + soneId++;
438 configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
439 configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
440 configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
441 configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
442 configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
443 Profile profile = sone.getProfile();
444 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
445 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
446 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
448 for (Post post : sone.getPosts()) {
449 String postPrefix = sonePrefix + "/Post." + postId++;
450 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
451 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
452 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
454 /* write null ID as terminator. */
455 configuration.getStringValue(sonePrefix + "/Post." + postId + "/ID").setValue(null);
458 for (Reply reply : sone.getReplies()) {
459 String replyPrefix = sonePrefix + "/Reply." + replyId++;
460 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
461 configuration.getStringValue(replyPrefix + "/Post").setValue(reply.getPost().getId());
462 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
463 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
465 /* write null ID as terminator. */
466 configuration.getStringValue(sonePrefix + "/Reply." + replyId + "/ID").setValue(null);
469 for (Sone friend : sone.getFriends()) {
470 String friendPrefix = sonePrefix + "/Friend." + friendId++;
471 configuration.getStringValue(friendPrefix + "/ID").setValue(friend.getId());
472 configuration.getStringValue(friendPrefix + "/Key").setValue(friend.getRequestUri().toString());
473 configuration.getStringValue(friendPrefix + "/Name").setValue(friend.getName());
475 /* write null ID as terminator. */
476 configuration.getStringValue(sonePrefix + "/Friend." + friendId + "/ID").setValue(null);
479 /* write null ID as terminator. */
480 configuration.getStringValue("Sone/Sone." + soneId + "/ID").setValue(null);
482 } catch (ConfigurationException ce1) {
483 logger.log(Level.WARNING, "Could not store configuration!", ce1);