2 * Meviz - Various tools collection to work with multimedia.
3 * Copyright (C) 2012, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 2 of the GNU General Public License
7 * as published by the Free Software Foundation.
10 package eu.svjatoslav.meviz.htmlindexer;
13 import java.io.FileNotFoundException;
14 import java.io.IOException;
15 import java.io.UnsupportedEncodingException;
16 import java.util.ArrayList;
17 import java.util.HashSet;
18 import java.util.List;
20 import org.apache.log4j.Logger;
22 import eu.svjatoslav.commons.file.IOHelper;
23 import eu.svjatoslav.commons.network.UrlParamEncoder;
24 import eu.svjatoslav.meviz.htmlindexer.metadata.Dimension;
25 import eu.svjatoslav.meviz.htmlindexer.metadata.DirectoryMetadata;
26 import eu.svjatoslav.meviz.htmlindexer.metadata.MetadadaHelper;
27 import eu.svjatoslav.meviz.htmlindexer.metadata.fileTypes.AbstractFile;
28 import eu.svjatoslav.meviz.htmlindexer.metadata.fileTypes.DirectoryFile;
29 import eu.svjatoslav.meviz.htmlindexer.metadata.fileTypes.GeneralFile;
30 import eu.svjatoslav.meviz.htmlindexer.metadata.fileTypes.Picture;
33 * Main class of HTML indexer.
36 public class FilesystemIndexer extends AbstractIndexer {
38 public static final Logger logger = Logger
39 .getLogger(FilesystemIndexer.class);
41 private final HashSet<String> validMetadataFiles = new HashSet<String>();
43 private final File directoryToIndex;
45 private File metadataFile;
47 private DirectoryMetadata metadata;
49 private final List<String> pathElements;
51 private HashSet<Layout> layouts;
53 private final CommandlineHandler commandlineHandler;
55 public FilesystemIndexer(final File directoryToIndex,
56 final CommandlineHandler commandlineHandler,
57 final List<String> pathElements) throws IOException,
60 this.directoryToIndex = directoryToIndex;
61 this.commandlineHandler = commandlineHandler;
62 this.pathElements = pathElements;
64 if (!directoryToIndex.canRead())
67 validMetadataFiles.add(Constants.METADATA_FILE_NAME);
69 initializeThumbnailsDirectory();
70 loadOrCreateMetadata();
76 metadata.removeUnusedMetadataEntries();
78 generateHtmlFromMetadata(layouts);
80 removeUnusedThumbnailFiles();
82 // save directory metadata
84 MetadadaHelper.saveDirectoryMetadata(metadataFile, metadata);
88 public boolean canWriteIndexFile(final File indexFile)
89 throws FileNotFoundException, IOException {
91 if (!indexFile.exists())
94 return Utils.isMevizGeneratedIndexFile(indexFile);
97 public void generateHtmlFromMetadata(final HashSet<Layout> layouts) {
98 // Generate HTML from metadata
99 for (final Layout layout : layouts)
101 final File indexFile = Utils.getLayoutIndexFile(layout,
104 if (canWriteIndexFile(indexFile)) {
106 indexForLayout(layout);
108 IOHelper.overwriteFileIfContentDiffers(indexFile, layout
109 .getHtml(true, true).getBytes());
111 } catch (final Exception e) {
112 logger.error("Error writing index file. ", e);
116 public List<String> getChildPath(final File file) {
118 final List<String> result = new ArrayList<String>();
119 result.addAll(pathElements);
120 result.add(file.getName());
126 public String getDirectoryUrl(final AbstractFile directory,
127 final IndexingContext context) {
128 return directory.fileName + "/index.html";
132 public String getParentDirectoryUrl(final IndexingContext context) {
133 return "../index.html";
137 public String getThumbnailUrl(final Picture picture,
138 final Dimension desiredDimension, final IndexingContext context) {
140 // in case thumbnail size was equal to original, then return original
142 if (picture.getDimensions().equals(desiredDimension))
143 return picture.fileName;
145 final String thumbnailFileName = picture
146 .getRelativeThumbnailFileName(desiredDimension);
148 validMetadataFiles.add(thumbnailFileName);
149 final File thumbnailFile = new File(
150 Utils.getThumbnailsDirectoryPath(directoryToIndex)
151 + thumbnailFileName);
153 if (!thumbnailFile.exists()) {
155 final File originalFile = new File(
156 directoryToIndex.getAbsolutePath() + "/" + picture.fileName);
158 // generate new thumbnail
159 Picture.makeThumbnail(originalFile, thumbnailFile,
160 desiredDimension.getAwtDimension());
162 return Constants.THUMBNAILS_DIRECTORY_NAME + "/"
163 + UrlParamEncoder.encode(thumbnailFileName);
166 public void indexForLayout(final Layout layout)
167 throws UnsupportedEncodingException {
169 for (final AbstractFile abstractFile : metadata.getFiles())
170 if (abstractFile instanceof GeneralFile) {
172 if (isOgv(abstractFile.getFileExtension()))
173 layout.enlistOgv(abstractFile);
175 layout.enlistFile(abstractFile);
177 } else if (abstractFile instanceof Picture)
178 layout.enlistImage(abstractFile);
179 else if (abstractFile instanceof DirectoryFile)
180 layout.enlistDirectory(abstractFile);
184 public void initializeLayouts() {
186 layouts = Utils.getLayouts();
188 final String galleryTitle = commandlineHandler.getGalleryTitle();
190 for (final Layout layout : layouts)
191 layout.init(galleryTitle, pathElements, this, new IndexingContext(
195 public void initializeThumbnailsDirectory() {
196 final File thumbnailsDirectory = Utils
197 .getThumbnailsDirectory(directoryToIndex);
199 if (!thumbnailsDirectory.exists())
200 thumbnailsDirectory.mkdirs();
203 public void loadOrCreateMetadata() {
205 metadataFile = new File(
206 Utils.getThumbnailsDirectoryPath(directoryToIndex)
207 + Constants.METADATA_FILE_NAME);
209 metadata = MetadadaHelper.initDirectoryMetadata(metadataFile);
212 private void removeUnusedThumbnailFiles() {
214 for (final File file : Utils.getThumbnailsDirectory(directoryToIndex)
216 if (!validMetadataFiles.contains(file.getName()))
221 public void updateMetadata() throws IOException, ImageFormatError {
223 final File[] directoryContent = directoryToIndex.listFiles();
225 for (final File file : directoryContent)
226 if (shallFileBeIndexed(file)) {
228 metadata.ensureFileMetainfoIsUpToDate(directoryToIndex, file);
230 if (file.isDirectory())
231 new FilesystemIndexer(file, commandlineHandler,