2 * jSite - ProjectInserter.java - Copyright © 2006–2014 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 2 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, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 package de.todesbaum.jsite.application;
22 import java.io.FileInputStream;
23 import java.io.FileNotFoundException;
24 import java.io.IOException;
25 import java.io.InputStream;
26 import java.util.ArrayList;
27 import java.util.Arrays;
28 import java.util.HashSet;
29 import java.util.Iterator;
30 import java.util.List;
32 import java.util.Map.Entry;
34 import java.util.concurrent.CountDownLatch;
35 import java.util.logging.Level;
36 import java.util.logging.Logger;
38 import net.pterodactylus.util.io.StreamCopier.ProgressListener;
40 import com.google.common.base.Optional;
41 import de.todesbaum.jsite.gui.FileScanner;
42 import de.todesbaum.jsite.gui.FileScanner.ScannedFile;
43 import de.todesbaum.jsite.gui.FileScannerListener;
44 import de.todesbaum.util.freenet.fcp2.Client;
45 import de.todesbaum.util.freenet.fcp2.ClientPutComplexDir;
46 import de.todesbaum.util.freenet.fcp2.Connection;
47 import de.todesbaum.util.freenet.fcp2.DirectFileEntry;
48 import de.todesbaum.util.freenet.fcp2.FileEntry;
49 import de.todesbaum.util.freenet.fcp2.Message;
50 import de.todesbaum.util.freenet.fcp2.PriorityClass;
51 import de.todesbaum.util.freenet.fcp2.RedirectFileEntry;
52 import de.todesbaum.util.freenet.fcp2.Verbosity;
55 * Manages project inserts.
57 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
59 public class ProjectInserter implements FileScannerListener, Runnable {
62 private static final Logger logger = Logger.getLogger(ProjectInserter.class.getName());
64 /** Random number for FCP instances. */
65 private static final int random = (int) (Math.random() * Integer.MAX_VALUE);
67 /** Counter for FCP connection identifier. */
68 private static int counter = 0;
70 private final ProjectInsertListeners projectInsertListeners = new ProjectInsertListeners();
72 /** The freenet interface. */
73 private Freenet7Interface freenetInterface;
75 /** The project to insert. */
76 private Project project;
78 /** The file scanner. */
79 private FileScanner fileScanner;
81 /** Object used for synchronization. */
82 private final Object lockObject = new Object();
84 /** The temp directory. */
85 private String tempDirectory;
87 /** The current connection. */
88 private Connection connection;
90 /** Whether the insert is cancelled. */
91 private volatile boolean cancelled = false;
93 /** Progress listener for payload transfers. */
94 private ProgressListener progressListener;
96 /** Whether to use “early encode.” */
97 private boolean useEarlyEncode;
99 /** The insert priority. */
100 private PriorityClass priority;
103 * Adds a listener to the list of registered listeners.
105 * @param insertListener
106 * The listener to add
108 public void addInsertListener(InsertListener insertListener) {
109 projectInsertListeners.addInsertListener(insertListener);
113 * Sets the project to insert.
116 * The project to insert
118 public void setProject(Project project) {
119 this.project = project;
123 * Sets the freenet interface to use.
125 * @param freenetInterface
126 * The freenet interface to use
128 public void setFreenetInterface(Freenet7Interface freenetInterface) {
129 this.freenetInterface = freenetInterface;
133 * Sets the temp directory to use.
135 * @param tempDirectory
136 * The temp directory to use, or {@code null} to use the system
139 public void setTempDirectory(String tempDirectory) {
140 this.tempDirectory = tempDirectory;
144 * Sets whether to use the “early encode“ flag for the insert.
146 * @param useEarlyEncode
147 * {@code true} to set the “early encode” flag for the insert,
148 * {@code false} otherwise
150 public void setUseEarlyEncode(boolean useEarlyEncode) {
151 this.useEarlyEncode = useEarlyEncode;
155 * Sets the insert priority.
158 * The insert priority
160 public void setPriority(PriorityClass priority) {
161 this.priority = priority;
167 * @param progressListener
168 * Listener to notify on progress events
170 public void start(ProgressListener progressListener) {
172 this.progressListener = progressListener;
173 fileScanner = new FileScanner(project);
174 fileScanner.addFileScannerListener(this);
175 new Thread(fileScanner).start();
179 * Stops the current insert.
183 synchronized (lockObject) {
184 if (connection != null) {
185 connection.disconnect();
191 * Creates a file entry suitable for handing in to
192 * {@link ClientPutComplexDir#addFileEntry(FileEntry)}.
195 * The name and hash of the file to insert
196 * @return A file entry for the given file
198 private FileEntry createFileEntry(ScannedFile file) {
199 String filename = file.getFilename();
200 FileOption fileOption = project.getFileOption(filename);
201 if (fileOption.isInsert()) {
202 fileOption.setCurrentHash(file.getHash());
203 /* check if file was modified. */
204 if (!project.isAlwaysForceInsert() && !fileOption.isForceInsert() && file.getHash().equals(fileOption.getLastInsertHash())) {
205 /* only insert a redirect. */
206 logger.log(Level.FINE, String.format("Inserting redirect to edition %d for %s.", fileOption.getLastInsertEdition(), filename));
207 return new RedirectFileEntry(fileOption.getChangedName().or(filename), fileOption.getMimeType(), "SSK@" + project.getRequestURI() + "/" + project.getPath() + "-" + fileOption.getLastInsertEdition() + "/" + fileOption.getLastInsertFilename());
210 return createFileEntry(filename, fileOption.getChangedName(), fileOption.getMimeType());
211 } catch (IOException ioe1) {
212 /* ignore, null is returned. */
215 if (fileOption.isInsertRedirect()) {
216 return new RedirectFileEntry(fileOption.getChangedName().or(filename), fileOption.getMimeType(), fileOption.getCustomKey());
222 private FileEntry createFileEntry(String filename, Optional<String> changedName, String mimeType) throws FileNotFoundException {
223 File physicalFile = new File(project.getLocalPath(), filename);
224 InputStream fileEntryInputStream = new FileInputStream(physicalFile);
225 return new DirectFileEntry(changedName.or(filename), mimeType, fileEntryInputStream, physicalFile.length());
229 * Validates the given project. The project will be checked for any invalid
230 * conditions, such as invalid insert or request keys, missing path names,
231 * missing default file, and so on.
234 * The project to check
235 * @return The encountered warnings and errors
237 public static CheckReport validateProject(Project project) {
238 CheckReport checkReport = new CheckReport();
239 if ((project.getLocalPath() == null) || (project.getLocalPath().trim().length() == 0)) {
240 checkReport.addIssue("error.no-local-path", true);
242 if ((project.getPath() == null) || (project.getPath().trim().length() == 0)) {
243 checkReport.addIssue("error.no-path", true);
245 if ((project.getIndexFile() == null) || (project.getIndexFile().length() == 0)) {
246 checkReport.addIssue("warning.empty-index", false);
248 File indexFile = new File(project.getLocalPath(), project.getIndexFile());
249 if (!indexFile.exists()) {
250 checkReport.addIssue("error.index-missing", true);
253 String indexFile = project.getIndexFile();
254 boolean hasIndexFile = (indexFile != null) && (indexFile.length() > 0);
255 List<String> allowedIndexContentTypes = Arrays.asList("text/html", "application/xhtml+xml");
256 if (hasIndexFile && !allowedIndexContentTypes.contains(project.getFileOption(indexFile).getMimeType())) {
257 checkReport.addIssue("warning.index-not-html", false);
259 Map<String, FileOption> fileOptions = project.getFileOptions();
260 Set<Entry<String, FileOption>> fileOptionEntries = fileOptions.entrySet();
261 boolean insert = fileOptionEntries.isEmpty();
262 for (Entry<String, FileOption> fileOptionEntry : fileOptionEntries) {
263 String fileName = fileOptionEntry.getKey();
264 FileOption fileOption = fileOptionEntry.getValue();
265 insert |= fileOption.isInsert() || fileOption.isInsertRedirect();
266 if (fileName.equals(project.getIndexFile()) && !fileOption.isInsert() && !fileOption.isInsertRedirect()) {
267 checkReport.addIssue("error.index-not-inserted", true);
269 if (!fileOption.isInsert() && fileOption.isInsertRedirect() && ((fileOption.getCustomKey().length() == 0) || "CHK@".equals(fileOption.getCustomKey()))) {
270 checkReport.addIssue("error.no-custom-key", true, fileName);
274 checkReport.addIssue("error.no-files-to-insert", true);
276 Set<String> fileNames = new HashSet<String>();
277 for (Entry<String, FileOption> fileOptionEntry : fileOptionEntries) {
278 FileOption fileOption = fileOptionEntry.getValue();
279 if (!fileOption.isInsert() && !fileOption.isInsertRedirect()) {
280 logger.log(Level.FINEST, "Ignoring {0}.", fileOptionEntry.getKey());
283 String fileName = fileOption.getChangedName().or(fileOptionEntry.getKey());
284 logger.log(Level.FINEST, "Adding “{0}” for {1}.", new Object[] { fileName, fileOptionEntry.getKey() });
285 if (!fileNames.add(fileName)) {
286 checkReport.addIssue("error.duplicate-file", true, fileName);
290 FileScanner fileScanner = new FileScanner(project);
291 final CountDownLatch completionLatch = new CountDownLatch(1);
292 fileScanner.addFileScannerListener(new FileScannerListener() {
295 public void fileScannerFinished(FileScanner fileScanner) {
296 completionLatch.countDown();
299 new Thread(fileScanner).start();
300 while (completionLatch.getCount() > 0) {
302 completionLatch.await();
303 } catch (InterruptedException ie1) {
307 for (ScannedFile scannedFile : fileScanner.getFiles()) {
308 String fileName = scannedFile.getFilename();
309 FileOption fileOption = project.getFileOption(fileName);
310 if ((fileOption != null) && !fileOption.isInsert()) {
313 totalSize += new File(project.getLocalPath(), fileName).length();
315 if (totalSize > 2 * 1024 * 1024) {
316 checkReport.addIssue("warning.site-larger-than-2-mib", false);
326 projectInsertListeners.fireProjectInsertStarted(project);
327 List<ScannedFile> files = fileScanner.getFiles();
329 /* create connection to node */
330 synchronized (lockObject) {
331 connection = freenetInterface.getConnection("project-insert-" + random + counter++);
333 connection.setTempDirectory(tempDirectory);
334 boolean connected = false;
335 Throwable cause = null;
337 connected = connection.connect();
338 } catch (IOException e1) {
342 if (!connected || cancelled) {
343 projectInsertListeners.fireProjectInsertFinished(project, false, cancelled ? new AbortedException() : cause);
347 Client client = new Client(connection);
350 int edition = project.getEdition();
351 String dirURI = "USK@" + project.getInsertURI() + "/" + project.getPath() + "/" + edition + "/";
352 ClientPutComplexDir putDir = new ClientPutComplexDir("dir-" + counter++, dirURI, tempDirectory);
353 if ((project.getIndexFile() != null) && (project.getIndexFile().length() > 0)) {
354 FileOption indexFileOption = project.getFileOption(project.getIndexFile());
355 Optional<String> changedName = indexFileOption.getChangedName();
356 if (changedName.isPresent()) {
357 putDir.setDefaultName(changedName.get());
359 putDir.setDefaultName(project.getIndexFile());
362 putDir.setVerbosity(Verbosity.ALL);
363 putDir.setMaxRetries(-1);
364 putDir.setEarlyEncode(useEarlyEncode);
365 putDir.setPriorityClass(priority);
366 for (ScannedFile file : files) {
367 FileEntry fileEntry = createFileEntry(file);
368 if (fileEntry != null) {
370 putDir.addFileEntry(fileEntry);
371 } catch (IOException ioe1) {
372 projectInsertListeners.fireProjectInsertFinished(project, false, ioe1);
380 client.execute(putDir, progressListener);
381 projectInsertListeners.fireProjectUploadFinished(project);
382 } catch (IOException ioe1) {
383 projectInsertListeners.fireProjectInsertFinished(project, false, ioe1);
387 /* parse progress and success messages */
388 String finalURI = null;
389 boolean success = false;
390 boolean finished = false;
391 boolean disconnected = false;
392 while (!finished && !cancelled) {
393 Message message = client.readMessage();
394 finished = (message == null) || (disconnected = client.isDisconnected());
395 logger.log(Level.FINE, "Received message: " + message);
397 @SuppressWarnings("null")
398 String messageName = message.getName();
399 if ("URIGenerated".equals(messageName)) {
400 finalURI = message.get("URI");
401 projectInsertListeners.fireProjectURIGenerated(project, finalURI);
403 if ("SimpleProgress".equals(messageName)) {
404 int total = Integer.parseInt(message.get("Total"));
405 int succeeded = Integer.parseInt(message.get("Succeeded"));
406 int fatal = Integer.parseInt(message.get("FatallyFailed"));
407 int failed = Integer.parseInt(message.get("Failed"));
408 boolean finalized = Boolean.parseBoolean(message.get("FinalizedTotal"));
409 projectInsertListeners.fireProjectInsertProgress(project, succeeded, failed, fatal, total, finalized);
411 success |= "PutSuccessful".equals(messageName);
412 finished = (success && (finalURI != null)) || "PutFailed".equals(messageName) || messageName.endsWith("Error");
416 /* post-insert work */
418 @SuppressWarnings("null")
419 String editionPart = finalURI.substring(finalURI.lastIndexOf('/') + 1);
420 int newEdition = Integer.parseInt(editionPart);
421 project.setEdition(newEdition);
422 project.setLastInsertionTime(System.currentTimeMillis());
423 project.onSuccessfulInsert();
425 projectInsertListeners.fireProjectInsertFinished(project, success, cancelled ? new AbortedException() : (disconnected ? new IOException("Connection terminated") : null));
429 // INTERFACE FileScannerListener
436 public void fileScannerFinished(FileScanner fileScanner) {
437 if (!fileScanner.isError()) {
438 new Thread(this).start();
440 projectInsertListeners.fireProjectInsertFinished(project, false, null);
442 fileScanner.removeFileScannerListener(this);
446 * Container class that collects all warnings and errors that occured during
447 * {@link ProjectInserter#validateProject(Project) project validation}.
449 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
451 public static class CheckReport implements Iterable<Issue> {
453 /** The issures that occured. */
454 private final List<Issue> issues = new ArrayList<Issue>();
462 public void addIssue(Issue issue) {
467 * Creates an {@link Issue} from the given error key and fatality flag
468 * and {@link #addIssue(Issue) adds} it.
473 * {@code true} if the error is fatal, {@code false} if only
474 * a warning should be generated
476 * Any additional parameters
478 public void addIssue(String errorKey, boolean fatal, String... parameters) {
479 addIssue(new Issue(errorKey, fatal, parameters));
486 public Iterator<Issue> iterator() {
487 return issues.iterator();
491 * Returns whether this check report does not contain any errors.
493 * @return {@code true} if this check report does not contain any
494 * errors, {@code false} if this check report does contain
497 public boolean isEmpty() {
498 return issues.isEmpty();
502 * Returns the number of issues in this check report.
504 * @return The number of issues
507 return issues.size();
513 * Container class for a single issue. An issue contains an error key
514 * that describes the error, and a fatality flag that determines whether
515 * the insert has to be aborted (if the flag is {@code true}) or if it
516 * can still be performed and only a warning should be generated (if the
517 * flag is {@code false}).
519 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’
522 public static class Issue {
524 /** The error key. */
525 private final String errorKey;
527 /** The fatality flag. */
528 private final boolean fatal;
530 /** Additional parameters. */
531 private String[] parameters;
534 * Creates a new issue.
541 * Any additional parameters
543 protected Issue(String errorKey, boolean fatal, String... parameters) {
544 this.errorKey = errorKey;
546 this.parameters = parameters;
550 * Returns the key of the encountered error.
552 * @return The error key
554 public String getErrorKey() {
559 * Returns whether the issue is fatal and the insert has to be
560 * aborted. Otherwise only a warning should be shown.
562 * @return {@code true} if the insert needs to be aborted, {@code
565 public boolean isFatal() {
570 * Returns any additional parameters.
572 * @return The additional parameters
574 public String[] getParameters() {