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 soneCache.put(sone.getId(), sone);
183 SoneInserter soneInserter = new SoneInserter(freenetInterface, sone);
184 soneInserter.start();
185 soneDownloader.addSone(sone);
186 soneInserters.put(sone, soneInserter);
191 * Adds a remote Sone so that it is watched for updates.
196 public void addSone(Sone sone) {
197 if (!soneCache.containsKey(sone.getId())) {
198 soneCache.put(sone.getId(), sone);
200 soneDownloader.addSone(sone);
204 * Creates a new Sone at a random location.
207 * The name of the Sone
208 * @return The created Sone
209 * @throws SoneException
210 * if a Sone error occurs
212 public Sone createSone(String name) throws SoneException {
213 return createSone(name, null, null);
217 * Creates a new Sone at the given location. If one of {@code requestUri} or
218 * {@code insertUrI} is {@code null}, the Sone is created at a random
222 * The name of the Sone
224 * The request URI of the Sone, or {@link NullPointerException}
225 * to create a Sone at a random location
227 * The insert URI of the Sone, or {@code null} to create a Sone
228 * at a random location
229 * @return The created Sone
230 * @throws SoneException
231 * if a Sone error occurs
233 public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
234 if ((name == null) || (name.trim().length() == 0)) {
235 throw new SoneException(Type.INVALID_SONE_NAME);
237 String finalRequestUri;
238 String finalInsertUri;
239 if ((requestUri == null) || (insertUri == null)) {
240 String[] keyPair = freenetInterface.generateKeyPair();
241 finalRequestUri = keyPair[0];
242 finalInsertUri = keyPair[1];
244 finalRequestUri = requestUri;
245 finalInsertUri = insertUri;
249 logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
250 sone = new Sone(UUID.randomUUID().toString()).setName(name).setRequestUri(new FreenetURI(finalRequestUri).setKeyType("USK").setDocName("Sone-" + name)).setInsertUri(new FreenetURI(finalInsertUri).setKeyType("USK").setDocName("Sone-" + name));
251 sone.setProfile(new Profile());
252 /* set modification counter to 1 so it is inserted immediately. */
253 sone.setModificationCounter(1);
255 } catch (MalformedURLException mue1) {
256 throw new SoneException(Type.INVALID_URI);
262 * Deletes the given Sone from this plugin instance.
267 public void deleteSone(Sone sone) {
268 SoneInserter soneInserter = soneInserters.remove(sone);
270 localSones.remove(sone);
274 * Returns the post with the given ID. If no post exists yet with the given
275 * ID, a new post is returned.
281 public Post getPost(String postId) {
282 if (!postCache.containsKey(postId)) {
283 postCache.put(postId, new Post(postId));
285 return postCache.get(postId);
289 * Returns the reply with the given ID. If no reply exists yet with the
290 * given ID, a new reply is returned.
293 * The ID of the reply
296 public Reply getReply(String replyId) {
297 if (!replyCache.containsKey(replyId)) {
298 replyCache.put(replyId, new Reply(replyId));
300 return replyCache.get(replyId);
304 * Gets all replies to the given post, sorted by date, oldest first.
307 * The post the replies refer to
308 * @return The sorted list of replies for the post
310 public List<Reply> getReplies(Post post) {
311 List<Reply> replies = new ArrayList<Reply>();
312 for (Reply reply : replyCache.values()) {
313 if (reply.getPost().equals(post)) {
317 Collections.sort(replies, new Comparator<Reply>() {
323 public int compare(Reply leftReply, Reply rightReply) {
324 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
338 protected void serviceStart() {
346 protected void serviceStop() {
347 soneDownloader.stop();
348 /* stop all Sone inserters. */
349 for (SoneInserter soneInserter : soneInserters.values()) {
360 * Loads the configuration.
362 private void loadConfiguration() {
363 logger.entering(Core.class.getName(), "loadConfiguration()");
365 /* parse local Sones. */
366 logger.log(Level.INFO, "Loading Sones…");
369 String sonePrefix = "Sone/Sone." + soneId++;
370 String id = configuration.getStringValue(sonePrefix + "/ID").getValue(null);
374 String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
375 String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
376 String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
377 long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
378 String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
379 String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
380 String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
382 Profile profile = new Profile();
383 profile.setFirstName(firstName);
384 profile.setMiddleName(middleName);
385 profile.setLastName(lastName);
386 Sone sone = new Sone(id).setName(name).setRequestUri(new FreenetURI(requestUri)).setInsertUri(new FreenetURI(insertUri));
387 soneCache.put(id, sone);
388 sone.setProfile(profile);
391 String postPrefix = sonePrefix + "/Post." + postId++;
392 id = configuration.getStringValue(postPrefix + "/ID").getValue(null);
396 long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
397 String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
398 Post post = getPost(id).setSone(sone).setTime(time).setText(text);
401 int replyCounter = 0;
403 String replyPrefix = sonePrefix + "/Reply." + replyCounter++;
404 String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
405 if (replyId == null) {
408 Sone replySone = getSone(configuration.getStringValue(replyPrefix + "/Sone/ID").getValue(null));
409 String replySoneKey = configuration.getStringValue(replyPrefix + "/Sone/Key").getValue(null);
410 String replySoneName = configuration.getStringValue(replyPrefix + "/Sone/Name").getValue(null);
411 replySone.setRequestUri(new FreenetURI(replySoneKey)).setName(replySoneName);
412 Post replyPost = postCache.get(configuration.getStringValue(replyPrefix + "/Post").getValue(null));
413 long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue(null);
414 String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
415 Reply reply = getReply(replyId).setSone(replySone).setPost(replyPost).setTime(replyTime).setText(replyText);
416 replyCache.put(replyId, reply);
420 int friendCounter = 0;
422 String friendPrefix = sonePrefix + "/Friend." + friendCounter++;
423 String friendId = configuration.getStringValue(friendPrefix + "/ID").getValue(null);
424 if (friendId == null) {
427 Sone friendSone = getSone(friendId);
428 String friendKey = configuration.getStringValue(friendPrefix + "/Key").getValue(null);
429 String friendName = configuration.getStringValue(friendPrefix + "/Name").getValue(null);
430 friendSone.setRequestUri(new FreenetURI(friendKey)).setName(friendName);
432 sone.addFriend(sone);
435 sone.setModificationCounter(modificationCounter);
437 } catch (MalformedURLException mue1) {
438 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
441 logger.log(Level.INFO, "Loaded %d Sones.", getSones().size());
443 logger.exiting(Core.class.getName(), "loadConfiguration()");
447 * Saves the configuraiton.
449 private void saveConfiguration() {
450 Set<Sone> sones = getSones();
451 logger.log(Level.INFO, "Storing %d Sones…", sones.size());
453 /* store all Sones. */
455 for (Sone sone : localSones) {
456 String sonePrefix = "Sone/Sone." + soneId++;
457 configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
458 configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
459 configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
460 configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
461 configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
462 Profile profile = sone.getProfile();
463 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
464 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
465 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
467 for (Post post : sone.getPosts()) {
468 String postPrefix = sonePrefix + "/Post." + postId++;
469 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
470 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
471 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
473 /* write null ID as terminator. */
474 configuration.getStringValue(sonePrefix + "/Post." + postId + "/ID").setValue(null);
477 for (Reply reply : sone.getReplies()) {
478 String replyPrefix = sonePrefix + "/Reply." + replyId++;
479 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
480 configuration.getStringValue(replyPrefix + "/Sone/ID").setValue(reply.getSone().getId());
481 configuration.getStringValue(replyPrefix + "/Sone/Key").setValue(reply.getSone().getRequestUri().toString());
482 configuration.getStringValue(replyPrefix + "/Sone/Name").setValue(reply.getSone().getName());
483 configuration.getStringValue(replyPrefix + "/Post").setValue(reply.getPost().getId());
484 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
485 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
487 /* write null ID as terminator. */
488 configuration.getStringValue(sonePrefix + "/Reply." + replyId + "/ID").setValue(null);
491 for (Sone friend : sone.getFriends()) {
492 String friendPrefix = sonePrefix + "/Friend." + friendId++;
493 configuration.getStringValue(friendPrefix + "/ID").setValue(friend.getId());
494 configuration.getStringValue(friendPrefix + "/Key").setValue(friend.getRequestUri().toString());
495 configuration.getStringValue(friendPrefix + "/Name").setValue(friend.getName());
497 /* write null ID as terminator. */
498 configuration.getStringValue(sonePrefix + "/Friend." + friendId + "/ID").setValue(null);
501 /* write null ID as terminator. */
502 configuration.getStringValue("Sone/Sone." + soneId + "/ID").setValue(null);
504 } catch (ConfigurationException ce1) {
505 logger.log(Level.WARNING, "Could not store configuration!", ce1);