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.client.FetchResult;
43 import freenet.keys.FreenetURI;
48 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
50 public class Core extends AbstractService {
53 private static final Logger logger = Logging.getLogger(Core.class);
55 /** The configuration. */
56 private Configuration configuration;
58 /** Interface to freenet. */
59 private FreenetInterface freenetInterface;
61 /** The Sone downloader. */
62 private SoneDownloader soneDownloader;
64 /** The local Sones. */
65 private final Set<Sone> localSones = new HashSet<Sone>();
67 /** Sone inserters. */
68 private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
70 /* various caches follow here. */
72 /** Cache for all known Sones. */
73 private final Map<String, Sone> soneCache = new HashMap<String, Sone>();
75 /** Cache for all known posts. */
76 private final Map<String, Post> postCache = new HashMap<String, Post>();
78 /** Cache for all known replies. */
79 private final Map<String, Reply> replyCache = new HashMap<String, Reply>();
93 * Sets the configuration of the core.
95 * @param configuration
96 * The configuration of the core
97 * @return This core (for method chaining)
99 public Core configuration(Configuration configuration) {
100 this.configuration = configuration;
105 * Sets the Freenet interface to use.
107 * @param freenetInterface
108 * The Freenet interface to use
109 * @return This core (for method chaining)
111 public Core freenetInterface(FreenetInterface freenetInterface) {
112 this.freenetInterface = freenetInterface;
113 soneDownloader = new SoneDownloader(this, freenetInterface);
114 soneDownloader.start();
119 * Returns the local Sones.
121 * @return The local Sones
123 public Set<Sone> getSones() {
124 return Collections.unmodifiableSet(localSones);
128 * Returns the Sone with the given ID, or an empty Sone that has been
129 * initialized with the given ID.
135 public Sone getSone(String soneId) {
136 if (!soneCache.containsKey(soneId)) {
137 Sone sone = new Sone(soneId);
138 soneCache.put(soneId, sone);
140 return soneCache.get(soneId);
144 * Creates a new post.
147 * The sone that creates the post
149 * The text of the post
150 * @return The created post
152 public Post createPost(Sone sone, String text) {
153 return createPost(sone, System.currentTimeMillis(), text);
157 * Creates a new post.
160 * The Sone that creates the post
162 * The time of the post
164 * The text of the post
165 * @return The created post
167 public Post createPost(Sone sone, long time, String text) {
168 Post post = getPost(UUID.randomUUID().toString()).setSone(sone).setTime(time).setText(text);
177 * The Sone that posts the reply
179 * The post the reply refers to
181 * The text of the reply
182 * @return The created reply
184 public Reply createReply(Sone sone, Post post, String text) {
185 return createReply(sone, post, System.currentTimeMillis(), text);
192 * The Sone that posts the reply
194 * The post the reply refers to
196 * The time of the post
198 * The text of the reply
199 * @return The created reply
201 public Reply createReply(Sone sone, Post post, long time, String text) {
202 Reply reply = getReply(UUID.randomUUID().toString()).setSone(sone).setPost(post).setTime(time).setText(text);
203 sone.addReply(reply);
212 * Adds a Sone to watch for updates. The Sone needs to be completely
216 * The Sone to watch for updates
218 public void addSone(Sone sone) {
219 soneDownloader.addSone(sone);
223 * Adds the given Sone.
228 public void addLocalSone(Sone sone) {
229 if (localSones.add(sone)) {
230 SoneInserter soneInserter = new SoneInserter(freenetInterface, sone);
231 soneInserter.start();
232 soneInserters.put(sone, soneInserter);
237 * Creates a new Sone at a random location.
240 * The name of the Sone
241 * @return The created Sone
242 * @throws SoneException
243 * if a Sone error occurs
245 public Sone createSone(String name) throws SoneException {
246 return createSone(name, null, null);
250 * Creates a new Sone at the given location. If one of {@code requestUri} or
251 * {@code insertUrI} is {@code null}, the Sone is created at a random
255 * The name of the Sone
257 * The request URI of the Sone, or {@link NullPointerException}
258 * to create a Sone at a random location
260 * The insert URI of the Sone, or {@code null} to create a Sone
261 * at a random location
262 * @return The created Sone
263 * @throws SoneException
264 * if a Sone error occurs
266 public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
267 if ((name == null) || (name.trim().length() == 0)) {
268 throw new SoneException(Type.INVALID_SONE_NAME);
270 String finalRequestUri;
271 String finalInsertUri;
272 if ((requestUri == null) || (insertUri == null)) {
273 String[] keyPair = freenetInterface.generateKeyPair();
274 finalRequestUri = keyPair[0];
275 finalInsertUri = keyPair[1];
277 finalRequestUri = requestUri;
278 finalInsertUri = insertUri;
282 logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
283 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));
284 sone.setProfile(new Profile());
285 /* set modification counter to 1 so it is inserted immediately. */
286 sone.setModificationCounter(1);
288 } catch (MalformedURLException mue1) {
289 throw new SoneException(Type.INVALID_URI);
295 * Loads the Sone from the given request URI.
298 * The request URI to load the Sone from
300 public void loadSone(String requestUri) {
302 FetchResult fetchResult = freenetInterface.fetchUri(new FreenetURI(requestUri).setMetaString(new String[] { "sone.xml" }));
303 soneDownloader.parseSone(null, fetchResult);
304 } catch (MalformedURLException mue1) {
305 logger.log(Level.INFO, "Could not create URI from “" + requestUri + "”.", mue1);
310 * Deletes the given Sone from this plugin instance.
315 public void deleteSone(Sone sone) {
316 SoneInserter soneInserter = soneInserters.remove(sone);
318 localSones.remove(sone);
322 * Returns the post with the given ID. If no post exists yet with the given
323 * ID, a new post is returned.
329 public Post getPost(String postId) {
330 if (!postCache.containsKey(postId)) {
331 postCache.put(postId, new Post(postId));
333 return postCache.get(postId);
337 * Returns the reply with the given ID. If no reply exists yet with the
338 * given ID, a new reply is returned.
341 * The ID of the reply
344 public Reply getReply(String replyId) {
345 if (!replyCache.containsKey(replyId)) {
346 replyCache.put(replyId, new Reply(replyId));
348 return replyCache.get(replyId);
352 * Gets all replies to the given post, sorted by date, oldest first.
355 * The post the replies refer to
356 * @return The sorted list of replies for the post
358 public List<Reply> getReplies(Post post) {
359 List<Reply> replies = new ArrayList<Reply>();
360 for (Reply reply : replyCache.values()) {
361 if (reply.getPost().equals(post)) {
365 Collections.sort(replies, new Comparator<Reply>() {
371 public int compare(Reply leftReply, Reply rightReply) {
372 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
386 protected void serviceStart() {
394 protected void serviceStop() {
395 soneDownloader.stop();
396 /* stop all Sone inserters. */
397 for (SoneInserter soneInserter : soneInserters.values()) {
408 * Loads the configuration.
410 private void loadConfiguration() {
411 logger.entering(Core.class.getName(), "loadConfiguration()");
413 /* parse local Sones. */
414 logger.log(Level.INFO, "Loading Sones…");
417 String sonePrefix = "Sone/Sone." + soneId++;
418 String id = configuration.getStringValue(sonePrefix + "/ID").getValue(null);
422 String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
423 String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
424 String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
425 long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
426 String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
427 String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
428 String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
430 Profile profile = new Profile();
431 profile.setFirstName(firstName);
432 profile.setMiddleName(middleName);
433 profile.setLastName(lastName);
434 Sone sone = getSone(id).setName(name).setRequestUri(new FreenetURI(requestUri)).setInsertUri(new FreenetURI(insertUri));
435 sone.setProfile(profile);
438 String postPrefix = sonePrefix + "/Post." + postId++;
439 id = configuration.getStringValue(postPrefix + "/ID").getValue(null);
443 long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
444 String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
445 Post post = getPost(id).setSone(sone).setTime(time).setText(text);
448 int replyCounter = 0;
450 String replyPrefix = sonePrefix + "/Reply." + replyCounter++;
451 String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
452 if (replyId == null) {
455 Post replyPost = getPost(configuration.getStringValue(replyPrefix + "/Post").getValue(null));
456 long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue(null);
457 String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
458 Reply reply = getReply(replyId).setSone(sone).setPost(replyPost).setTime(replyTime).setText(replyText);
459 sone.addReply(reply);
463 int friendCounter = 0;
465 String friendPrefix = sonePrefix + "/Friend." + friendCounter++;
466 String friendId = configuration.getStringValue(friendPrefix + "/ID").getValue(null);
467 if (friendId == null) {
470 Sone friendSone = getSone(friendId);
471 String friendKey = configuration.getStringValue(friendPrefix + "/Key").getValue(null);
472 String friendName = configuration.getStringValue(friendPrefix + "/Name").getValue(null);
473 friendSone.setRequestUri(new FreenetURI(friendKey)).setName(friendName);
474 soneDownloader.addSone(friendSone);
475 sone.addFriend(friendSone);
478 sone.setModificationCounter(modificationCounter);
480 } catch (MalformedURLException mue1) {
481 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
484 logger.log(Level.INFO, "Loaded %d Sones.", getSones().size());
486 logger.exiting(Core.class.getName(), "loadConfiguration()");
490 * Saves the configuraiton.
492 private void saveConfiguration() {
493 Set<Sone> sones = getSones();
494 logger.log(Level.INFO, "Storing %d Sones…", sones.size());
496 /* store all Sones. */
498 for (Sone sone : localSones) {
499 String sonePrefix = "Sone/Sone." + soneId++;
500 configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
501 configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
502 configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
503 configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
504 configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
505 Profile profile = sone.getProfile();
506 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
507 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
508 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
510 for (Post post : sone.getPosts()) {
511 String postPrefix = sonePrefix + "/Post." + postId++;
512 configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
513 configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
514 configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
516 /* write null ID as terminator. */
517 configuration.getStringValue(sonePrefix + "/Post." + postId + "/ID").setValue(null);
520 for (Reply reply : sone.getReplies()) {
521 String replyPrefix = sonePrefix + "/Reply." + replyId++;
522 configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
523 configuration.getStringValue(replyPrefix + "/Post").setValue(reply.getPost().getId());
524 configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
525 configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
527 /* write null ID as terminator. */
528 configuration.getStringValue(sonePrefix + "/Reply." + replyId + "/ID").setValue(null);
531 for (Sone friend : sone.getFriends()) {
532 String friendPrefix = sonePrefix + "/Friend." + friendId++;
533 configuration.getStringValue(friendPrefix + "/ID").setValue(friend.getId());
534 configuration.getStringValue(friendPrefix + "/Key").setValue(friend.getRequestUri().toString());
535 configuration.getStringValue(friendPrefix + "/Name").setValue(friend.getName());
537 /* write null ID as terminator. */
538 configuration.getStringValue(sonePrefix + "/Friend." + friendId + "/ID").setValue(null);
541 /* write null ID as terminator. */
542 configuration.getStringValue("Sone/Sone." + soneId + "/ID").setValue(null);
544 } catch (ConfigurationException ce1) {
545 logger.log(Level.WARNING, "Could not store configuration!", ce1);