org.gradle.internal.resource.local.DefaultPathKeyFileStore Maven / Gradle / Ivy
Show all versions of gradle-api Show documentation
/*
* Copyright 2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.internal.resource.local;
import org.apache.commons.io.FileUtils;
import org.gradle.api.Action;
import org.gradle.api.NonNullApi;
import org.gradle.api.file.EmptyFileVisitor;
import org.gradle.api.file.FileVisitDetails;
import org.gradle.api.internal.file.collections.MinimalFileTree;
import org.gradle.api.internal.file.collections.SingleIncludePatternFileTree;
import org.gradle.internal.UncheckedException;
import org.gradle.internal.file.PathTraversalChecker;
import org.gradle.internal.hash.ChecksumService;
import org.gradle.util.internal.GFileUtils;
import org.gradle.util.internal.RelativePathUtil;
import java.io.File;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import static org.gradle.internal.FileUtils.hasExtension;
/**
* File store that accepts the target path as the key for the entry.
*
* This implementation is explicitly NOT THREAD SAFE. Concurrent access must be organised externally.
*
* There is always at most one entry for a given key for this file store. If an entry already exists at the given path, it will be overwritten.
* Paths can contain directory components, which will be created on demand.
*
* This file store is self repairing in so far that any files partially written before a fatal error will be ignored and
* removed at a later time.
*
* This file store also provides searching via relative ant path patterns.
*/
@NonNullApi
public class DefaultPathKeyFileStore implements PathKeyFileStore {
private final ChecksumService checksumService;
/*
When writing a file into the filestore a marker file with this suffix is written alongside,
then removed after the write. This is used to detect partially written files (due to a serious crash)
and to silently clean them.
*/
public static final String IN_PROGRESS_MARKER_FILE_SUFFIX = ".fslck";
private File baseDir;
public DefaultPathKeyFileStore(ChecksumService checksumService, File baseDir) {
this.checksumService = checksumService;
this.baseDir = baseDir;
}
protected File getBaseDir() {
return baseDir;
}
private File getFile(String... path) {
String composedPath;
if (path.length == 1) {
composedPath = path[0];
} else {
// We need to ignore empty Strings as this is what "new File(parent, path)" was doing for "path" empty.
composedPath = Arrays.stream(path)
.filter(((Predicate) String::isEmpty).negate())
.collect(Collectors.joining(File.separator));
}
return new File(baseDir, PathTraversalChecker.safePathName(trimLeadingSlash(composedPath)));
}
private File getFileWhileCleaningInProgress(String... path) {
File file = getFile(path);
File markerFile = getInProgressMarkerFile(file);
if (markerFile.exists()) {
deleteFileQuietly(file);
deleteFileQuietly(markerFile);
}
return file;
}
@Override
public LocallyAvailableResource add(final String path, final Action addAction) {
try {
return doAdd(path, new Action() {
@Override
public void execute(File file) {
try {
addAction.execute(file);
} catch (Throwable e) {
throw new FileStoreAddActionException(String.format("Failed to add into filestore '%s' at '%s' ", getBaseDir().getAbsolutePath(), path), e);
}
}
});
} catch (FileStoreAddActionException e) {
throw e;
} catch (Throwable e) {
throw new FileStoreException(String.format("Failed to add into filestore '%s' at '%s' ", getBaseDir().getAbsolutePath(), path), e);
}
}
@Override
public LocallyAvailableResource move(String path, final File source) {
if (!source.exists()) {
throw new FileStoreException(String.format("Cannot move '%s' into filestore @ '%s' as it does not exist", source, path));
}
try {
return doAdd(path, new Action() {
@Override
public void execute(File file) {
if (source.isDirectory()) {
GFileUtils.moveExistingDirectory(source, file);
} else {
GFileUtils.moveExistingFile(source, file);
}
}
});
} catch (Throwable e) {
throw new FileStoreException(String.format("Failed to move file '%s' into filestore at '%s' ", source, path), e);
}
}
private LocallyAvailableResource doAdd(String path, Action action) {
File destination = getFile(path);
doAdd(destination, action);
return entryAt(path);
}
protected void doAdd(File destination, Action action) {
GFileUtils.parentMkdirs(destination);
File inProgressMarkerFile = getInProgressMarkerFile(destination);
GFileUtils.touch(inProgressMarkerFile);
try {
FileUtils.deleteQuietly(destination);
action.execute(destination);
} catch (Throwable t) {
FileUtils.deleteQuietly(destination);
throw UncheckedException.throwAsUncheckedException(t);
} finally {
deleteFileQuietly(inProgressMarkerFile);
}
}
@Override
public Set search(String pattern) {
if (!getBaseDir().exists()) {
return Collections.emptySet();
}
final Set entries = new HashSet();
findFiles(pattern).visit(new EmptyFileVisitor() {
@Override
public void visitFile(FileVisitDetails fileDetails) {
final File file = fileDetails.getFile();
// We cannot clean in progress markers, or in progress files here because
// the file system visitor stuff can't handle the file system mutating while visiting
if (!isInProgressMarkerFile(file) && !isInProgressFile(file)) {
entries.add(entryAt(file));
}
}
});
return entries;
}
private File getInProgressMarkerFile(File file) {
return new File(file.getParent(), file.getName() + IN_PROGRESS_MARKER_FILE_SUFFIX);
}
private boolean isInProgressMarkerFile(File file) {
return hasExtension(file, IN_PROGRESS_MARKER_FILE_SUFFIX);
}
private boolean isInProgressFile(File file) {
return getInProgressMarkerFile(file).exists();
}
private MinimalFileTree findFiles(String pattern) {
return new SingleIncludePatternFileTree(baseDir, pattern);
}
protected LocallyAvailableResource entryAt(File file) {
return entryAt(RelativePathUtil.relativePath(baseDir, file));
}
protected LocallyAvailableResource entryAt(final String path) {
return new DefaultLocallyAvailableResource(getFile(path), checksumService);
}
@Override
public LocallyAvailableResource get(String... path) {
final File file = getFileWhileCleaningInProgress(path);
if (file.exists()) {
return new DefaultLocallyAvailableResource(getFile(path), checksumService);
} else {
return null;
}
}
@SuppressWarnings("ResultOfMethodCallIgnored")
private static void deleteFileQuietly(File file) {
file.delete();
}
private static String trimLeadingSlash(String composedPath) {
if (!composedPath.isEmpty() && composedPath.charAt(0) == '/') {
return composedPath.substring(1);
}
return composedPath;
}}