2 * Sone - SoneRescuer.java - Copyright © 2011–2013 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 net.pterodactylus.sone.data.Sone;
21 import net.pterodactylus.util.service.AbstractService;
22 import freenet.keys.FreenetURI;
25 * The Sone rescuer downloads older editions of a Sone and updates the currently
26 * stored Sone with it.
28 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30 public class SoneRescuer extends AbstractService {
33 private final Core core;
35 /** The Sone downloader. */
36 private final SoneDownloader soneDownloader;
38 /** The Sone being rescued. */
39 private final Sone sone;
41 /** Whether the rescuer is currently fetching a Sone. */
42 private volatile boolean fetching;
44 /** The currently tried edition. */
45 private volatile long currentEdition;
47 /** Whether the last fetch was successful. */
48 private volatile boolean lastFetchSuccessful = true;
51 * Creates a new Sone rescuer.
55 * @param soneDownloader
60 public SoneRescuer(Core core, SoneDownloader soneDownloader, Sone sone) {
61 super("Sone Rescuer for " + sone.getName());
63 this.soneDownloader = soneDownloader;
65 currentEdition = sone.getRequestUri().getEdition();
73 * Returns whether the Sone rescuer is currently fetching a Sone.
75 * @return {@code true} if the Sone rescuer is currently fetching a Sone
77 @SuppressWarnings("unused") // used in rescue.html
78 public boolean isFetching() {
83 * Returns the edition that is currently being downloaded.
85 * @return The edition that is currently being downloaded
87 @SuppressWarnings("unused") // used in rescue.html
88 public long getCurrentEdition() {
89 return currentEdition;
93 * Returns whether the Sone rescuer can download a next edition.
95 * @return {@code true} if the Sone rescuer can download a next edition,
96 * {@code false} if the last edition was already tried
98 public boolean hasNextEdition() {
99 return currentEdition > 0;
103 * Returns the next edition the Sone rescuer can download.
105 * @return The next edition the Sone rescuer can download
107 @SuppressWarnings("unused") // used in rescue.html
108 public long getNextEdition() {
109 return currentEdition - 1;
113 * Sets the edition to rescue.
116 * The edition to rescue
117 * @return This Sone rescuer
119 public SoneRescuer setEdition(long edition) {
120 currentEdition = edition;
125 * Sets whether the last fetch was successful.
127 * @return {@code true} if the last fetch was successful, {@code false}
130 @SuppressWarnings("unused") // used in rescue.html
131 public boolean isLastFetchSuccessful() {
132 return lastFetchSuccessful;
140 * Starts the next fetch. If you want to fetch a different edition than “the
141 * next older one,” remember to call {@link #setEdition(long)} before
142 * calling this method.
144 public void startNextFetch() {
157 protected void serviceRun() {
158 while (!shouldStop()) {
159 while (!shouldStop() && !fetching) {
164 FreenetURI soneUri = sone.getRequestUri().setKeyType("SSK").setDocName("Sone-" + currentEdition).setMetaString(new String[] { "sone.xml" });
165 System.out.println("URI: " + soneUri);
166 Sone fetchedSone = soneDownloader.fetchSone(sone, soneUri, true);
167 System.out.println("Sone: " + fetchedSone);
168 lastFetchSuccessful = (fetchedSone != null);
169 if (lastFetchSuccessful) {
170 core.updateSone(fetchedSone, true);