sheepit-shadow-nabber/src/main/java/com/sheepit/client/config/DirectoryManager.java

/*
 * Copyright (C) 2023 Laurent CLOUET
 * Author Laurent CLOUET <laurent.clouet@nopnop.net>
 *
 * 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; version 2
 * of the License.
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package com.sheepit.client.config;

import com.sheepit.client.logger.Log;
import com.sheepit.client.datamodel.server.Chunk;
import com.sheepit.client.utils.Utils;
import lombok.AllArgsConstructor;
import org.apache.commons.io.FilenameUtils;

import java.io.File;
import java.io.IOException;
import java.nio.file.FileSystemException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;
import java.util.concurrent.CompletableFuture;

@AllArgsConstructor
public class DirectoryManager {
	private Configuration configuration;
	
	public String getActualStoragePathFor(Chunk chunk) {
		return isSharedEnabled() ? getSharedPathFor(chunk) : getCachePathFor(chunk);
	}
	
	public String getCachePathFor(Chunk chunk) {
		return configuration.getWoolCacheDirectory().getAbsolutePath() + File.separator + chunk.getId() + ".wool";
	}
	
	public String getSharedPathFor(Chunk chunk) {
		return configuration.getSharedDownloadsDirectory().getAbsolutePath() + File.separator + chunk.getId() + ".wool";
	}
	
	public boolean isSharedEnabled() {
		return configuration.getSharedDownloadsDirectory() != null && configuration.getSharedDownloadsDirectory().exists();
	}
	
	public boolean copyChunkFromSharedToCache(Chunk chunk) {
		return copyFileFromSharedToCache(getSharedPathFor(chunk), getCachePathFor(chunk));
	}
	
	private static final Log log = Log.getInstance();
	
	private boolean copyFileFromSharedToCache(String source, String target) {
		Path existingArchivePath = Paths.get(source);
		Path targetArchivePath = Paths.get(target);
		
		if (existingArchivePath.equals(targetArchivePath)) {
			// target are the same, do nothing
			return true;
		}
		
		try {
			Files.deleteIfExists(targetArchivePath);  // createLink only works if the target does not exist
			try {
				Files.createLink(targetArchivePath, existingArchivePath);
				Log.getInstance().debug("Created hardlink from " + targetArchivePath + " to " + existingArchivePath);
			}
			catch (UnsupportedOperationException // underlying file system does not support hard-linking
				   | FileSystemException       // cache-dir and shared-zip are on separate file systems, even though hard-linking is supported
				   | SecurityException         // user is not allowed to create hard-links
				ignore) {
				// Creating hardlinks might not be supported on some filesystems
				log.debug("Failed to create hardlink, falling back to copying file to " + targetArchivePath);
				Files.copy(existingArchivePath, targetArchivePath, StandardCopyOption.REPLACE_EXISTING);
			}
		}
		catch (IOException e) {
			log.error("Error while copying " + source + " from shared downloads directory to working dir");
			return false;
		}
		
		return true;
	}
	
	/**
	 * Creates cache directory
	 */
	public void createCacheDir() {
		this.removeWorkingDirectory();
		
		this.configuration.getWorkingDirectory().mkdirs();
		this.configuration.getWoolCacheDirectory().mkdirs();
		
		if (this.configuration.getSharedDownloadsDirectory() != null) {
			this.configuration.getSharedDownloadsDirectory().mkdirs();

			if (this.configuration.getSharedDownloadsDirectory().exists() == false) {
				log.error("DirectoryManager::createCacheDir Unable to create common directory " + this.configuration.getSharedDownloadsDirectory().getAbsolutePath());
			}
		}
	}

	public CompletableFuture<Void> createCacheDirAsync() {
		return CompletableFuture.runAsync(this::createCacheDir);
	}
	
	/**
	 * Cleans working directory and also deletes it if the user hasn't specified a cache directory
	 */
	public void removeWorkingDirectory() {
		if (this.configuration.isUserHasSpecifiedACacheDir()) {
			this.cleanWorkingDirectory();
		}
		else {
			Utils.delete(this.configuration.getWorkingDirectory());
		}
	}
	
	/**
	 * Deletes the working and storage directories
	 */
	public void cleanWorkingDirectory() {
		new DirectoryCleaner(this.configuration.getWorkingDirectory()).run();
		new DirectoryCleaner(this.configuration.getWoolCacheDirectory()).run();
		new DirectoryCleaner(this.configuration.getSharedDownloadsDirectory()).run();
	}
	
	/**
	 * @return a list of archives (files with extension .wool) in the
	 * working, storage, and shared downloads directories as long as they are not null
	 */
	public List<File> getLocalCacheFiles() {
		List<File> filesLocal = new LinkedList<File>();
		List<File> files = new LinkedList<File>();
		if (this.configuration.getWorkingDirectory() != null) {
			File[] filesInDirectory = this.configuration.getWorkingDirectory().listFiles();
			if (filesInDirectory != null) {
				files.addAll(Arrays.asList(filesInDirectory));
			}
		}
		if (this.configuration.getWoolCacheDirectory() != null) {
			File[] filesInDirectory = this.configuration.getWoolCacheDirectory().listFiles();
			if (filesInDirectory != null) {
				files.addAll(Arrays.asList(filesInDirectory));
			}
		}
		if (this.configuration.getSharedDownloadsDirectory() != null) {
			File[] filesInDirectory = this.configuration.getSharedDownloadsDirectory().listFiles();
			if (filesInDirectory != null) {
				files.addAll(Arrays.asList(filesInDirectory));
			}
		}
		
		for (File file : files) {
			if (file.isFile()) {
				try {
					String extension = FilenameUtils.getExtension(file.getName()).toLowerCase();
					String name = FilenameUtils.removeExtension(file.getName());
					if ("wool".equals(extension)) {
						// check if the md5 of the file is ok
						String md5Local = Utils.md5(file.getAbsolutePath());
						
						if (md5Local.equals(name)) {
							filesLocal.add(file);
						}
					}
				}
				catch (IllegalArgumentException e) { // because the file does not have an . his path
				}
			}
		}
		
		return filesLocal;
	}
	
	/**
	 * Runs through all SheepIt related directories and checks if files and folders are all readable, writeable
	 * and in case of directories, checks if the contents can be listed and if usable space is enough.
	 * Only logs instances where something was detected, otherwise is it will only print "FilesystemHealthCheck started"
	 * @return an ArrayList of Strings containing all logs of the FSHealth check
	 */
	public List<String> filesystemHealthCheck() {
		List<String> logs = new ArrayList<>();
		String f = "FSHealth: ";
		logs.add(f + "FilesystemHealthCheck started");
		List<File> dirsToCheck = new ArrayList<>();
		List<File> dirsChecked = new ArrayList<>();
		dirsToCheck.add(configuration.getWorkingDirectory().getAbsoluteFile());
		if (configuration.getSharedDownloadsDirectory() != null && dirsToCheck.contains(configuration.getSharedDownloadsDirectory().getAbsoluteFile()) == false) {
			dirsToCheck.add(configuration.getSharedDownloadsDirectory().getAbsoluteFile());
		}
		if (configuration.getWoolCacheDirectory() != null && dirsToCheck.contains(configuration.getWoolCacheDirectory().getAbsoluteFile()) == false) {
			dirsToCheck.add(configuration.getWoolCacheDirectory().getAbsoluteFile());
		}
		ListIterator<File> dirs = dirsToCheck.listIterator();
		while (dirs.hasNext()) {
			File dir = dirs.next();
			dirs.remove();
			dirsChecked.add(dir);
			File[] fileList = dir.listFiles();
			if (fileList == null) {
				logs.add(f + "File list of " + dir + " is null");
			}
			else {
				for (File file : fileList) {
					file = file.getAbsoluteFile();
					//logs.add(f + file);
					boolean canRead = file.canRead();
					boolean canWrite = file.canWrite();
					boolean isDir = file.isDirectory();
					if (canRead == false) {
						logs.add(f + "Can't read from " + file);
					}
					if (canWrite == false) {
						logs.add(f + "Can't write to " + file);
					}
					if (canRead && canWrite && isDir) {
						if (dirsChecked.contains(file)) {
							logs.add(f + "Dir " + file + " already checked. Loop detected");
						}
						else {
							dirs.add(file);
						}
						long usableSpace = file.getUsableSpace();
						if (usableSpace < 512 * 1024) {
							logs.add(f + "Usable space is " + usableSpace + " for " + file);
						}
					}
				}
			}
		}
		return logs;
	}
}