Persist list of blocked Sone IDs.
[Sone.git] / src / main / java / net / pterodactylus / sone / core / Core.java
1 /*
2  * FreenetSone - Core.java - Copyright © 2010 David Roden
3  *
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.
8  *
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.
13  *
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/>.
16  */
17
18 package net.pterodactylus.sone.core;
19
20 import java.net.MalformedURLException;
21 import java.util.ArrayList;
22 import java.util.Collection;
23 import java.util.Collections;
24 import java.util.Comparator;
25 import java.util.HashMap;
26 import java.util.HashSet;
27 import java.util.List;
28 import java.util.Map;
29 import java.util.Set;
30 import java.util.UUID;
31 import java.util.logging.Level;
32 import java.util.logging.Logger;
33
34 import net.pterodactylus.sone.core.SoneException.Type;
35 import net.pterodactylus.sone.data.Post;
36 import net.pterodactylus.sone.data.Profile;
37 import net.pterodactylus.sone.data.Reply;
38 import net.pterodactylus.sone.data.Sone;
39 import net.pterodactylus.util.config.Configuration;
40 import net.pterodactylus.util.config.ConfigurationException;
41 import net.pterodactylus.util.filter.Filter;
42 import net.pterodactylus.util.filter.Filters;
43 import net.pterodactylus.util.logging.Logging;
44 import net.pterodactylus.util.service.AbstractService;
45 import freenet.client.FetchResult;
46 import freenet.keys.FreenetURI;
47
48 /**
49  * The Sone core.
50  *
51  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
52  */
53 public class Core extends AbstractService {
54
55         /** The logger. */
56         private static final Logger logger = Logging.getLogger(Core.class);
57
58         /** The configuration. */
59         private Configuration configuration;
60
61         /** Interface to freenet. */
62         private FreenetInterface freenetInterface;
63
64         /** The Sone downloader. */
65         private SoneDownloader soneDownloader;
66
67         /** The local Sones. */
68         private final Set<Sone> localSones = new HashSet<Sone>();
69
70         /** Sone inserters. */
71         private final Map<Sone, SoneInserter> soneInserters = new HashMap<Sone, SoneInserter>();
72
73         /* various caches follow here. */
74
75         /** Cache for all known Sones. */
76         private final Map<String, Sone> soneCache = new HashMap<String, Sone>();
77
78         /** Cache for all known posts. */
79         private final Map<String, Post> postCache = new HashMap<String, Post>();
80
81         /** Cache for all known replies. */
82         private final Map<String, Reply> replyCache = new HashMap<String, Reply>();
83
84         /**
85          * Creates a new core.
86          */
87         public Core() {
88                 super("Sone Core");
89         }
90
91         //
92         // ACCESSORS
93         //
94
95         /**
96          * Sets the configuration of the core.
97          *
98          * @param configuration
99          *            The configuration of the core
100          * @return This core (for method chaining)
101          */
102         public Core configuration(Configuration configuration) {
103                 this.configuration = configuration;
104                 return this;
105         }
106
107         /**
108          * Sets the Freenet interface to use.
109          *
110          * @param freenetInterface
111          *            The Freenet interface to use
112          * @return This core (for method chaining)
113          */
114         public Core freenetInterface(FreenetInterface freenetInterface) {
115                 this.freenetInterface = freenetInterface;
116                 soneDownloader = new SoneDownloader(this, freenetInterface);
117                 soneDownloader.start();
118                 return this;
119         }
120
121         /**
122          * Returns the local Sones.
123          *
124          * @return The local Sones
125          */
126         public Set<Sone> getSones() {
127                 return Collections.unmodifiableSet(localSones);
128         }
129
130         /**
131          * Returns the Sone with the given ID, or an empty Sone that has been
132          * initialized with the given ID.
133          *
134          * @param soneId
135          *            The ID of the Sone
136          * @return The Sone
137          */
138         public Sone getSone(String soneId) {
139                 if (!soneCache.containsKey(soneId)) {
140                         Sone sone = new Sone(soneId);
141                         soneCache.put(soneId, sone);
142                 }
143                 return soneCache.get(soneId);
144         }
145
146         /**
147          * Returns all known sones.
148          *
149          * @return All known sones
150          */
151         public Collection<Sone> getKnownSones() {
152                 return soneCache.values();
153         }
154
155         /**
156          * Gets all known Sones that are not local Sones.
157          *
158          * @return All remote Sones
159          */
160         public Collection<Sone> getRemoteSones() {
161                 return Filters.filteredCollection(getKnownSones(), new Filter<Sone>() {
162
163                         @Override
164                         @SuppressWarnings("synthetic-access")
165                         public boolean filterObject(Sone object) {
166                                 return !localSones.contains(object);
167                         }
168                 });
169         }
170
171         /**
172          * Creates a new post and adds it to the given Sone.
173          *
174          * @param sone
175          *            The sone that creates the post
176          * @param text
177          *            The text of the post
178          * @return The created post
179          */
180         public Post createPost(Sone sone, String text) {
181                 return createPost(sone, System.currentTimeMillis(), text);
182         }
183
184         /**
185          * Creates a new post and adds it to the given Sone.
186          *
187          * @param sone
188          *            The Sone that creates the post
189          * @param time
190          *            The time of the post
191          * @param text
192          *            The text of the post
193          * @return The created post
194          */
195         public Post createPost(Sone sone, long time, String text) {
196                 Post post = getPost(UUID.randomUUID().toString()).setSone(sone).setTime(time).setText(text);
197                 sone.addPost(post);
198                 return post;
199         }
200
201         /**
202          * Creates a reply.
203          *
204          * @param sone
205          *            The Sone that posts the reply
206          * @param post
207          *            The post the reply refers to
208          * @param text
209          *            The text of the reply
210          * @return The created reply
211          */
212         public Reply createReply(Sone sone, Post post, String text) {
213                 return createReply(sone, post, System.currentTimeMillis(), text);
214         }
215
216         /**
217          * Creates a reply.
218          *
219          * @param sone
220          *            The Sone that posts the reply
221          * @param post
222          *            The post the reply refers to
223          * @param time
224          *            The time of the post
225          * @param text
226          *            The text of the reply
227          * @return The created reply
228          */
229         public Reply createReply(Sone sone, Post post, long time, String text) {
230                 Reply reply = getReply(UUID.randomUUID().toString()).setSone(sone).setPost(post).setTime(time).setText(text);
231                 sone.addReply(reply);
232                 return reply;
233         }
234
235         //
236         // ACTIONS
237         //
238
239         /**
240          * Adds a Sone to watch for updates. The Sone needs to be completely
241          * initialized.
242          *
243          * @param sone
244          *            The Sone to watch for updates
245          */
246         public void addSone(Sone sone) {
247                 soneCache.put(sone.getId(), sone);
248                 if (!localSones.contains(sone)) {
249                         soneDownloader.addSone(sone);
250                 }
251         }
252
253         /**
254          * Adds the given Sone.
255          *
256          * @param sone
257          *            The Sone to add
258          */
259         public void addLocalSone(Sone sone) {
260                 if (localSones.add(sone)) {
261                         SoneInserter soneInserter = new SoneInserter(freenetInterface, sone);
262                         soneInserter.start();
263                         soneInserters.put(sone, soneInserter);
264                 }
265         }
266
267         /**
268          * Creates a new Sone at a random location.
269          *
270          * @param name
271          *            The name of the Sone
272          * @return The created Sone
273          * @throws SoneException
274          *             if a Sone error occurs
275          */
276         public Sone createSone(String name) throws SoneException {
277                 return createSone(name, null, null);
278         }
279
280         /**
281          * Creates a new Sone at the given location. If one of {@code requestUri} or
282          * {@code insertUrI} is {@code null}, the Sone is created at a random
283          * location.
284          *
285          * @param name
286          *            The name of the Sone
287          * @param requestUri
288          *            The request URI of the Sone, or {@link NullPointerException}
289          *            to create a Sone at a random location
290          * @param insertUri
291          *            The insert URI of the Sone, or {@code null} to create a Sone
292          *            at a random location
293          * @return The created Sone
294          * @throws SoneException
295          *             if a Sone error occurs
296          */
297         public Sone createSone(String name, String requestUri, String insertUri) throws SoneException {
298                 if ((name == null) || (name.trim().length() == 0)) {
299                         throw new SoneException(Type.INVALID_SONE_NAME);
300                 }
301                 String finalRequestUri;
302                 String finalInsertUri;
303                 if ((requestUri == null) || (insertUri == null)) {
304                         String[] keyPair = freenetInterface.generateKeyPair();
305                         finalRequestUri = keyPair[0];
306                         finalInsertUri = keyPair[1];
307                 } else {
308                         finalRequestUri = requestUri;
309                         finalInsertUri = insertUri;
310                 }
311                 Sone sone;
312                 try {
313                         logger.log(Level.FINEST, "Creating new Sone “%s” at %s (%s)…", new Object[] { name, finalRequestUri, finalInsertUri });
314                         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));
315                         sone.setProfile(new Profile());
316                         /* set modification counter to 1 so it is inserted immediately. */
317                         sone.setModificationCounter(1);
318                         addLocalSone(sone);
319                 } catch (MalformedURLException mue1) {
320                         throw new SoneException(Type.INVALID_URI);
321                 }
322                 return sone;
323         }
324
325         /**
326          * Loads the Sone from the given request URI. The fetching of the data is
327          * performed in a new thread so this method returns immediately.
328          *
329          * @param requestUri
330          *            The request URI to load the Sone from
331          */
332         public void loadSone(final String requestUri) {
333                 loadSone(requestUri, null);
334         }
335
336         /**
337          * Loads the Sone from the given request URI. The fetching of the data is
338          * performed in a new thread so this method returns immediately. If
339          * {@code insertUri} is not {@code null} the loaded Sone is converted into a
340          * local Sone and available using as any other local Sone.
341          *
342          * @param requestUri
343          *            The request URI to load the Sone from
344          * @param insertUri
345          *            The insert URI of the Sone
346          */
347         public void loadSone(final String requestUri, final String insertUri) {
348                 new Thread(new Runnable() {
349
350                         @Override
351                         @SuppressWarnings("synthetic-access")
352                         public void run() {
353                                 try {
354                                         FreenetURI realRequestUri = new FreenetURI(requestUri).setMetaString(new String[] { "sone.xml" });
355                                         FetchResult fetchResult = freenetInterface.fetchUri(realRequestUri);
356                                         Sone parsedSone = soneDownloader.parseSone(null, fetchResult, realRequestUri);
357                                         if (parsedSone != null) {
358                                                 if (insertUri != null) {
359                                                         parsedSone.setInsertUri(new FreenetURI(insertUri));
360                                                         addLocalSone(parsedSone);
361                                                 } else {
362                                                         addSone(parsedSone);
363                                                 }
364                                         }
365                                 } catch (MalformedURLException mue1) {
366                                         logger.log(Level.INFO, "Could not create URI from “" + requestUri + "”.", mue1);
367                                 }
368                         }
369                 }, "Sone Downloader").start();
370         }
371
372         /**
373          * Loads and updates the given Sone.
374          *
375          * @param sone
376          *            The Sone to load
377          */
378         public void loadSone(final Sone sone) {
379                 new Thread(new Runnable() {
380
381                         @Override
382                         @SuppressWarnings("synthetic-access")
383                         public void run() {
384                                 FreenetURI realRequestUri = sone.getRequestUri().setMetaString(new String[] { "sone.xml" });
385                                 FetchResult fetchResult = freenetInterface.fetchUri(realRequestUri);
386                                 Sone parsedSone = soneDownloader.parseSone(sone, fetchResult, realRequestUri);
387                                 if (parsedSone != null) {
388                                         addSone(parsedSone);
389                                 }
390                         }
391                 }, "Sone Downloader").start();
392         }
393
394         /**
395          * Deletes the given Sone from this plugin instance.
396          *
397          * @param sone
398          *            The sone to delete
399          */
400         public void deleteSone(Sone sone) {
401                 SoneInserter soneInserter = soneInserters.remove(sone);
402                 soneInserter.stop();
403                 localSones.remove(sone);
404         }
405
406         /**
407          * Returns the post with the given ID. If no post exists yet with the given
408          * ID, a new post is returned.
409          *
410          * @param postId
411          *            The ID of the post
412          * @return The post
413          */
414         public Post getPost(String postId) {
415                 if (!postCache.containsKey(postId)) {
416                         postCache.put(postId, new Post(postId));
417                 }
418                 return postCache.get(postId);
419         }
420
421         /**
422          * Returns the reply with the given ID. If no reply exists yet with the
423          * given ID, a new reply is returned.
424          *
425          * @param replyId
426          *            The ID of the reply
427          * @return The reply
428          */
429         public Reply getReply(String replyId) {
430                 if (!replyCache.containsKey(replyId)) {
431                         replyCache.put(replyId, new Reply(replyId));
432                 }
433                 return replyCache.get(replyId);
434         }
435
436         /**
437          * Gets all replies to the given post, sorted by date, oldest first.
438          *
439          * @param post
440          *            The post the replies refer to
441          * @return The sorted list of replies for the post
442          */
443         public List<Reply> getReplies(Post post) {
444                 List<Reply> replies = new ArrayList<Reply>();
445                 for (Reply reply : replyCache.values()) {
446                         if (reply.getPost().equals(post)) {
447                                 replies.add(reply);
448                         }
449                 }
450                 Collections.sort(replies, new Comparator<Reply>() {
451
452                         /**
453                          * {@inheritDoc}
454                          */
455                         @Override
456                         public int compare(Reply leftReply, Reply rightReply) {
457                                 return (int) Math.max(Integer.MIN_VALUE, Math.min(Integer.MAX_VALUE, leftReply.getTime() - rightReply.getTime()));
458                         }
459                 });
460                 return replies;
461         }
462
463         //
464         // SERVICE METHODS
465         //
466
467         /**
468          * {@inheritDoc}
469          */
470         @Override
471         protected void serviceStart() {
472                 loadConfiguration();
473         }
474
475         /**
476          * {@inheritDoc}
477          */
478         @Override
479         protected void serviceStop() {
480                 soneDownloader.stop();
481                 /* stop all Sone inserters. */
482                 for (SoneInserter soneInserter : soneInserters.values()) {
483                         soneInserter.stop();
484                 }
485                 saveConfiguration();
486         }
487
488         //
489         // PRIVATE METHODS
490         //
491
492         /**
493          * Loads the configuration.
494          */
495         private void loadConfiguration() {
496                 logger.entering(Core.class.getName(), "loadConfiguration()");
497
498                 /* parse local Sones. */
499                 logger.log(Level.INFO, "Loading Sones…");
500                 int soneId = 0;
501                 do {
502                         String sonePrefix = "Sone/Sone." + soneId++;
503                         String id = configuration.getStringValue(sonePrefix + "/ID").getValue(null);
504                         if (id == null) {
505                                 break;
506                         }
507                         String name = configuration.getStringValue(sonePrefix + "/Name").getValue(null);
508                         String insertUri = configuration.getStringValue(sonePrefix + "/InsertURI").getValue(null);
509                         String requestUri = configuration.getStringValue(sonePrefix + "/RequestURI").getValue(null);
510                         long modificationCounter = configuration.getLongValue(sonePrefix + "/ModificationCounter").getValue((long) 0);
511                         String firstName = configuration.getStringValue(sonePrefix + "/Profile/FirstName").getValue(null);
512                         String middleName = configuration.getStringValue(sonePrefix + "/Profile/MiddleName").getValue(null);
513                         String lastName = configuration.getStringValue(sonePrefix + "/Profile/LastName").getValue(null);
514                         try {
515                                 Profile profile = new Profile();
516                                 profile.setFirstName(firstName);
517                                 profile.setMiddleName(middleName);
518                                 profile.setLastName(lastName);
519                                 Sone sone = getSone(id).setName(name).setRequestUri(new FreenetURI(requestUri)).setInsertUri(new FreenetURI(insertUri));
520                                 sone.setProfile(profile);
521                                 int postId = 0;
522                                 do {
523                                         String postPrefix = sonePrefix + "/Post." + postId++;
524                                         id = configuration.getStringValue(postPrefix + "/ID").getValue(null);
525                                         if (id == null) {
526                                                 break;
527                                         }
528                                         long time = configuration.getLongValue(postPrefix + "/Time").getValue(null);
529                                         String text = configuration.getStringValue(postPrefix + "/Text").getValue(null);
530                                         Post post = getPost(id).setSone(sone).setTime(time).setText(text);
531                                         sone.addPost(post);
532                                 } while (true);
533                                 int replyCounter = 0;
534                                 do {
535                                         String replyPrefix = sonePrefix + "/Reply." + replyCounter++;
536                                         String replyId = configuration.getStringValue(replyPrefix + "/ID").getValue(null);
537                                         if (replyId == null) {
538                                                 break;
539                                         }
540                                         Post replyPost = getPost(configuration.getStringValue(replyPrefix + "/Post").getValue(null));
541                                         long replyTime = configuration.getLongValue(replyPrefix + "/Time").getValue(null);
542                                         String replyText = configuration.getStringValue(replyPrefix + "/Text").getValue(null);
543                                         Reply reply = getReply(replyId).setSone(sone).setPost(replyPost).setTime(replyTime).setText(replyText);
544                                         sone.addReply(reply);
545                                 } while (true);
546
547                                 /* load friends. */
548                                 int friendCounter = 0;
549                                 while (true) {
550                                         String friendPrefix = sonePrefix + "/Friend." + friendCounter++;
551                                         String friendId = configuration.getStringValue(friendPrefix + "/ID").getValue(null);
552                                         if (friendId == null) {
553                                                 break;
554                                         }
555                                         Sone friendSone = getSone(friendId);
556                                         String friendKey = configuration.getStringValue(friendPrefix + "/Key").getValue(null);
557                                         String friendName = configuration.getStringValue(friendPrefix + "/Name").getValue(null);
558                                         friendSone.setRequestUri(new FreenetURI(friendKey)).setName(friendName);
559                                         sone.addFriend(friendSone);
560                                 }
561
562                                 /* load blocked Sone IDs. */
563                                 int blockedSoneCounter = 0;
564                                 while (true) {
565                                         String blockedSonePrefix = sonePrefix + "/BlockedSone." + blockedSoneCounter++;
566                                         String blockedSoneId = configuration.getStringValue(blockedSonePrefix + "/ID").getValue(null);
567                                         if (blockedSoneId == null) {
568                                                 break;
569                                         }
570                                         sone.addBlockedSoneId(blockedSoneId);
571                                 }
572
573                                 sone.setModificationCounter(modificationCounter);
574                                 addLocalSone(sone);
575                         } catch (MalformedURLException mue1) {
576                                 logger.log(Level.WARNING, "Could not create Sone from requestUri (“" + requestUri + "”) and insertUri (“" + insertUri + "”)!", mue1);
577                         }
578                 } while (true);
579                 logger.log(Level.INFO, "Loaded %d Sones.", getSones().size());
580
581                 /* load all remote Sones. */
582                 for (Sone remoteSone : getRemoteSones()) {
583                         loadSone(remoteSone);
584                 }
585
586                 logger.exiting(Core.class.getName(), "loadConfiguration()");
587         }
588
589         /**
590          * Saves the configuraiton.
591          */
592         private void saveConfiguration() {
593                 Set<Sone> sones = getSones();
594                 logger.log(Level.INFO, "Storing %d Sones…", sones.size());
595                 try {
596                         /* store all Sones. */
597                         int soneId = 0;
598                         for (Sone sone : localSones) {
599                                 String sonePrefix = "Sone/Sone." + soneId++;
600                                 configuration.getStringValue(sonePrefix + "/ID").setValue(sone.getId());
601                                 configuration.getStringValue(sonePrefix + "/Name").setValue(sone.getName());
602                                 configuration.getStringValue(sonePrefix + "/RequestURI").setValue(sone.getRequestUri().toString());
603                                 configuration.getStringValue(sonePrefix + "/InsertURI").setValue(sone.getInsertUri().toString());
604                                 configuration.getLongValue(sonePrefix + "/ModificationCounter").setValue(sone.getModificationCounter());
605                                 Profile profile = sone.getProfile();
606                                 configuration.getStringValue(sonePrefix + "/Profile/FirstName").setValue(profile.getFirstName());
607                                 configuration.getStringValue(sonePrefix + "/Profile/MiddleName").setValue(profile.getMiddleName());
608                                 configuration.getStringValue(sonePrefix + "/Profile/LastName").setValue(profile.getLastName());
609                                 int postId = 0;
610                                 for (Post post : sone.getPosts()) {
611                                         String postPrefix = sonePrefix + "/Post." + postId++;
612                                         configuration.getStringValue(postPrefix + "/ID").setValue(post.getId());
613                                         configuration.getLongValue(postPrefix + "/Time").setValue(post.getTime());
614                                         configuration.getStringValue(postPrefix + "/Text").setValue(post.getText());
615                                 }
616                                 /* write null ID as terminator. */
617                                 configuration.getStringValue(sonePrefix + "/Post." + postId + "/ID").setValue(null);
618
619                                 int replyId = 0;
620                                 for (Reply reply : sone.getReplies()) {
621                                         String replyPrefix = sonePrefix + "/Reply." + replyId++;
622                                         configuration.getStringValue(replyPrefix + "/ID").setValue(reply.getId());
623                                         configuration.getStringValue(replyPrefix + "/Post").setValue(reply.getPost().getId());
624                                         configuration.getLongValue(replyPrefix + "/Time").setValue(reply.getTime());
625                                         configuration.getStringValue(replyPrefix + "/Text").setValue(reply.getText());
626                                 }
627                                 /* write null ID as terminator. */
628                                 configuration.getStringValue(sonePrefix + "/Reply." + replyId + "/ID").setValue(null);
629
630                                 int friendId = 0;
631                                 for (Sone friend : sone.getFriends()) {
632                                         String friendPrefix = sonePrefix + "/Friend." + friendId++;
633                                         configuration.getStringValue(friendPrefix + "/ID").setValue(friend.getId());
634                                         configuration.getStringValue(friendPrefix + "/Key").setValue(friend.getRequestUri().toString());
635                                         configuration.getStringValue(friendPrefix + "/Name").setValue(friend.getName());
636                                 }
637                                 /* write null ID as terminator. */
638                                 configuration.getStringValue(sonePrefix + "/Friend." + friendId + "/ID").setValue(null);
639
640                                 /* write all blocked Sones. */
641                                 int blockedSoneCounter = 0;
642                                 for (String blockedSoneId : sone.getBlockedSoneIds()) {
643                                         String blockedSonePrefix = sonePrefix + "/BlockedSone." + blockedSoneCounter++;
644                                         configuration.getStringValue(blockedSonePrefix + "/ID").setValue(blockedSoneId);
645                                 }
646                                 configuration.getStringValue(sonePrefix + "/BlockedSone." + blockedSoneCounter + "/ID").setValue(null);
647
648                         }
649                         /* write null ID as terminator. */
650                         configuration.getStringValue("Sone/Sone." + soneId + "/ID").setValue(null);
651
652                 } catch (ConfigurationException ce1) {
653                         logger.log(Level.WARNING, "Could not store configuration!", ce1);
654                 }
655         }
656
657 }