org.syncany.operations.actions.FileCreatingFileSystemAction.java Source code

Introduction

Here is the source code for org.syncany.operations.actions.FileCreatingFileSystemAction.java

Source

/*
 * Syncany, www.syncany.org
 * Copyright (C) 2011-2013 Philipp C. Heckel <philipp.heckel@gmail.com> 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.syncany.operations.actions;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.logging.Level;

import org.apache.commons.io.FileUtils;
import org.syncany.chunk.MultiChunk;
import org.syncany.chunk.MultiChunker;
import org.syncany.config.Config;
import org.syncany.database.ChunkEntry.ChunkChecksum;
import org.syncany.database.Database;
import org.syncany.database.FileContent;
import org.syncany.database.FileVersion;
import org.syncany.database.FileVersion.FileType;
import org.syncany.database.MultiChunkEntry;
import org.syncany.util.FileUtil;

public abstract class FileCreatingFileSystemAction extends FileSystemAction {
    public FileCreatingFileSystemAction(Config config, Database localDatabase, Database winningDatabase,
            FileVersion file1, FileVersion file2) {
        super(config, localDatabase, winningDatabase, file1, file2);
    }

    protected void createFileFolderOrSymlink(FileVersion reconstructedFileVersion) throws Exception {
        if (reconstructedFileVersion.getType() == FileType.FILE) {
            createFile(reconstructedFileVersion);
        } else if (reconstructedFileVersion.getType() == FileType.FOLDER) {
            createFolder(reconstructedFileVersion);
        } else if (reconstructedFileVersion.getType() == FileType.SYMLINK) {
            createSymlink(reconstructedFileVersion);
        } else {
            logger.log(Level.INFO, "     - Unknown file type: " + reconstructedFileVersion.getType());
            throw new Exception("Unknown file type: " + reconstructedFileVersion.getType());
        }
    }

    protected void createFolder(FileVersion reconstructedFileVersion) throws IOException {
        File reconstructedFilesAtFinalLocation = getAbsolutePathFile(reconstructedFileVersion.getPath());
        logger.log(Level.INFO, "     - Creating folder at " + reconstructedFilesAtFinalLocation + " ...");

        reconstructedFilesAtFinalLocation.mkdirs();
        setFileAttributes(reconstructedFileVersion);
    }

    protected void createFile(FileVersion reconstructedFileVersion) throws Exception {
        File reconstructedFileAtFinalLocation = getAbsolutePathFile(reconstructedFileVersion.getPath());
        File reconstructedFileInCache = config.getCache().createTempFile("reconstructedFileVersion");
        logger.log(Level.INFO, "     - Creating file " + reconstructedFileVersion.getPath() + " to "
                + reconstructedFileInCache + " ...");

        FileContent fileContent = localDatabase.getContent(reconstructedFileVersion.getChecksum());

        if (fileContent == null) {
            fileContent = winningDatabase.getContent(reconstructedFileVersion.getChecksum());
        }

        // Create file
        // TODO [low] Create an assembler/reconstructor class to package re-assembly in the chunk-package
        MultiChunker multiChunker = config.getMultiChunker();
        FileOutputStream reconstructedFileOutputStream = new FileOutputStream(reconstructedFileInCache);

        if (fileContent != null) { // File can be empty!
            Collection<ChunkChecksum> fileChunks = fileContent.getChunks();

            for (ChunkChecksum chunkChecksum : fileChunks) {
                MultiChunkEntry multiChunkForChunk = localDatabase.getMultiChunkForChunk(chunkChecksum);

                if (multiChunkForChunk == null) {
                    multiChunkForChunk = winningDatabase.getMultiChunkForChunk(chunkChecksum);
                }

                File decryptedMultiChunkFile = config.getCache()
                        .getDecryptedMultiChunkFile(multiChunkForChunk.getId().getRaw());

                MultiChunk multiChunk = multiChunker.createMultiChunk(decryptedMultiChunkFile);
                InputStream chunkInputStream = multiChunk.getChunkInputStream(chunkChecksum.getRaw());

                FileUtil.appendToOutputStream(chunkInputStream, reconstructedFileOutputStream);
            }
        }

        reconstructedFileOutputStream.close();

        // Make directory if it does not exist
        File reconstructedFileParentDir = reconstructedFileAtFinalLocation.getParentFile();

        if (!FileUtil.exists(reconstructedFileParentDir)) {
            logger.log(Level.INFO,
                    "     - Parent folder does not exist, creating " + reconstructedFileParentDir + " ...");
            reconstructedFileParentDir.mkdirs();
        }

        // Okay. Now move to real place
        if (!isLegalFilename(reconstructedFileAtFinalLocation)) {
            File illegalFile = reconstructedFileAtFinalLocation;
            reconstructedFileAtFinalLocation = cleanFilename(reconstructedFileAtFinalLocation);

            logger.log(Level.SEVERE, "     - Filename was ILLEGAL, cleaned from {0} to {1}",
                    new Object[] { illegalFile.getName(), reconstructedFileAtFinalLocation.getName() });
        }

        logger.log(Level.INFO, "     - Okay, now moving to " + reconstructedFileAtFinalLocation + " ...");
        FileUtils.moveFile(reconstructedFileInCache, reconstructedFileAtFinalLocation); // TODO [medium] This should be in a try/catch block

        // Set attributes & timestamp
        setFileAttributes(reconstructedFileVersion, reconstructedFileAtFinalLocation);
        setLastModified(reconstructedFileVersion);
    }

    private boolean isLegalFilename(File file) throws IOException {
        try {
            file.createNewFile();
            file.delete();

            return true;
        } catch (IOException e) {
            logger.log(Level.SEVERE, "WARNING: Illegal file: " + file);
            return false;
        }
    }

    private File cleanFilename(File conflictFile) {
        String originalDirectory = FileUtil.getAbsoluteParentDirectory(conflictFile);
        String originalBasename = FileUtil.getBasename(conflictFile);
        String originalFileExtension = FileUtil.getExtension(originalBasename, false);

        boolean originalFileHasExtension = originalFileExtension != null && !"".equals(originalFileExtension);

        String newFullName;

        if (originalFileHasExtension) {
            String conflictBasename = cleanOsSpecificString(originalBasename);
            String conflictFileExtension = cleanOsSpecificString(originalFileExtension);

            newFullName = String.format("%s (filename conflict).%s", conflictBasename, conflictFileExtension);
        } else {
            String conflictBasename = cleanOsSpecificString(originalBasename);
            newFullName = String.format("%s (filename conflict)", conflictBasename);
        }

        return new File(originalDirectory + File.separator + newFullName);
    }

    private String cleanOsSpecificString(String originalBasename) {
        if (FileUtil.isWindows()) {
            return originalBasename.replaceAll("[\\/:*?\"<>|]", "");
        } else {
            return originalBasename.replaceAll("[/]", "");
        }
    }
}