sheepit-shadow-nabber/src/main/java/com/sheepit/client/Configuration.java

/*
 * Copyright (C) 2010-2014 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;

import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;

import com.sheepit.client.hardware.cpu.CPU;
import com.sheepit.client.hardware.gpu.GPUDevice;
import com.sheepit.client.os.OS;
import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * Provides facilities regarding the configuration of the SheepIt client
 */
@AllArgsConstructor
@Data public class Configuration {
	
	public static final String jarVersion = getJarVersion();
	
	public enum ComputeType {
		CPU_GPU, CPU, GPU
	} // accept job for ...
	
	private String configFilePath;
	private String logDirectory;
	private File workingDirectory;
	private File sharedDownloadsDirectory;
	private File storageDirectory; // for permanent storage (binary archive)
	private boolean userHasSpecifiedACacheDir;
	private String static_exeDirName;
	private String login;
	private String password;
	private String proxy;
	private int maxUploadingJob;
	private int nbCores;
	private long maxAllowedMemory; // in KiB, max memory allowed for render
	private int maxRenderTime; // max render time per frame allowed
	private int priority;
	private ComputeType computeMethod;
	private GPUDevice GPUDevice;
	private boolean detectGPUs;
	private boolean printLog;
	private boolean debugLevel;
	private List<Pair<Calendar, Calendar>> requestTime;
	private long shutdownTime;
	private String shutdownMode;
	private String extras;
	private boolean autoSignIn;
	private boolean useSysTray;
	private boolean headless;
	private String UIType;
	private String hostname;
	private String theme;
	private boolean disableLargeDownloads;
	
	public Configuration(File cache_dir_, String login_, String password_) {
		this.configFilePath = null;
		this.logDirectory = null;
		this.login = login_;
		this.password = password_;
		this.proxy = null;
		this.hostname = this.getDefaultHostname();
		this.static_exeDirName = "exe";
		this.maxUploadingJob = 1;
		this.nbCores = -1; // ie not set
		this.maxAllowedMemory = -1; // ie not set
		this.maxRenderTime = -1; // ie not set
		this.priority = 19; // default lowest
		this.computeMethod = null;
		this.GPUDevice = null;
		this.userHasSpecifiedACacheDir = false;
		this.detectGPUs = true;
		this.workingDirectory = null;
		this.sharedDownloadsDirectory = null;
		this.storageDirectory = null;
		this.setCacheDir(cache_dir_);
		this.printLog = false;
		this.debugLevel = false;
		this.requestTime = null;
		this.shutdownTime = -1;
		this.shutdownMode = "soft";
		this.extras = "";
		this.autoSignIn = false;
		this.useSysTray = false;
		this.headless = java.awt.GraphicsEnvironment.isHeadless();
		this.UIType = null;
		this.theme = null;
		this.disableLargeDownloads = false;
	}
	
	/**
	 * @return string formatted with SheepIt Admin Log Viewer in mind
	 */
	@Override public String toString() {
		String c = "    CFG: ";
		String n ="\n";
		return
				c + "version:                   " + getJarVersion() + n +
				c + "configFilePath:            " + configFilePath + n +
				c + "logDir:                    " + (logDirectory == null ? "NULL" : logDirectory) + n +
				c + "workingDirectory:          " + workingDirectory + n +
				c + "sharedDownloadsDirectory:  " + sharedDownloadsDirectory + n +
				c + "storageDirectory:          " + storageDirectory + n +
				c + "userHasSpecifiedACacheDir: " + userHasSpecifiedACacheDir + n +
				c + "static_exeDirName:         " + static_exeDirName + n +
				c + "login:                     " + login + n +
				c + "proxy:                     " + proxy + n +
				c + "maxUploadingJob:           " + maxUploadingJob + n +
				c + "nbCores:                   " + nbCores + n +
				c + "maxAllowedMemory:          " + maxAllowedMemory + n +
				c + "maxRenderTime:             " + maxRenderTime + n +
				c + "priority:                  " + priority + n +
				c + "computeMethod:             " + computeMethod + n +
				c + "GPUDevice:                 " + GPUDevice + n +
				c + "detectGPUs:                " + detectGPUs + n +
				c + "printLog:                  " + printLog + n +
				c + "debugLog:                  " + debugLevel + n +
				c + "requestTime:               " + requestTime + n +
				c + "shutdownTime:              " + shutdownTime + n +
				c + "shutdownMode:              " + shutdownMode + n +
				c + "extras:                    " + extras + n +
				c + "autoSignIn:                " + autoSignIn + n +
				c + "useSysTray:                " + useSysTray + n +
				c + "headless:                  " + headless + n +
				c + "UIType:                    " + UIType + n +
				c + "hostname:                  " + hostname + n +
				c + "theme:                     " + theme + n +
				c + "disableLargeDownloads:      " + disableLargeDownloads;
	}
	
	/**
	 * Sets the priority that Blender will be started with
	 * @param priority integer that will be clamped between 19 and -19,
	 *                 lowest to highest in terms of priority
	 */
	public void setPriority(int priority) {
		if (priority > 19)
			priority = 19;
		else if (priority < -19)
			priority = -19;
		
		this.priority = priority;
	}
	
	/**
	 * Returns ordinal integer of the computeMethod enum
	 * @return ordinal integer of the computeMethod enum
	 */
	public int computeMethodToInt() {
		return this.computeMethod.ordinal();
	}
	
	/**
	 * Sets and optionally creates cache directory
	 * @param cache_dir_ File representing cache directory
	 */
	public void setCacheDir(File cache_dir_) {
		removeWorkingDirectory();
		if (cache_dir_ == null) {
			this.userHasSpecifiedACacheDir = false;
			try {
				this.workingDirectory = File.createTempFile("farm_", "");
				this.workingDirectory.createNewFile(); // hoho...
				this.workingDirectory.delete(); // hoho
				this.workingDirectory.mkdir();
				this.workingDirectory.deleteOnExit();
				
				// since there is no working directory and the client will be working in the system temp directory,
				// we can also set up a 'permanent' directory for immutable files (like renderer binary)
				
				this.storageDirectory = new File(this.workingDirectory.getParent() + File.separator + "sheepit_binary_cache");
				this.storageDirectory.mkdir();
			}
			catch (IOException e) {
				e.printStackTrace();
			}
		}
		else {
			this.userHasSpecifiedACacheDir = true;
			this.workingDirectory = new File(cache_dir_.getAbsolutePath() + File.separator + "sheepit");
			this.storageDirectory = new File(cache_dir_.getAbsolutePath() + File.separator + "sheepit_binary_cache");
			this.workingDirectory.mkdirs();
			this.storageDirectory.mkdirs();
		}
		
		if (this.sharedDownloadsDirectory != null) {
			this.sharedDownloadsDirectory.mkdirs();
			
			if (!this.sharedDownloadsDirectory.exists()) {
				System.err.println("Configuration::setCacheDir Unable to create common directory " + this.sharedDownloadsDirectory.getAbsolutePath());
			}
		}
	}
	
	/**
	 * @return the storage directory or the working directory if the former is not defined
	 */
	public File getStorageDir() {
		return this.storageDirectory == null ? this.workingDirectory : this.storageDirectory;
	}
	
	/**
	 * @return the user specified cache directory or null if it hasn't been specified
	 */
	public File getCacheDirForSettings() {
		// when the user has a cache directory specified,
		// a "sheepit" and "sheepit_binary_cache" directory is to be automatically created
		return this.userHasSpecifiedACacheDir == false ? null : this.workingDirectory.getParentFile();
	}
	
	/**
	 * @return string-representation of the hostname or an empty string if an error was encountered
	 */
	public String getDefaultHostname() {
		try {
			return InetAddress.getLocalHost().getHostName();
		}
		catch (UnknownHostException e) {
			return "";
		}
	}
	
	/**
	 * Deletes the working and storage directories
	 */
	public void cleanWorkingDirectory() {
		this.cleanDirectory(this.workingDirectory);
		this.cleanDirectory(this.storageDirectory);
	}
	
	/**
	 * Cleans a directory and removes files in it from the md5 cache
	 * @param dir representing the directory to be cleaned
	 * @return false if the dir null, true otherwise
	 */
	public boolean cleanDirectory(File dir) {
		if (dir == null) {
			return false;
		}
		
		File[] files = dir.listFiles();
		if (files != null) {
			for (File file : files) {
				if (file.isDirectory()) {
					Utils.delete(file);
				}
				else {
					try {
						String extension = file.getName().substring(file.getName().lastIndexOf('.')).toLowerCase();
						String name = file.getName().substring(0, file.getName().length() - 1 * extension.length());
						if (".zip".equals(extension) || ".wool".equals(extension)) {
							// check if the md5 of the file is ok
							String md5_local = Utils.md5(file.getAbsolutePath());
							
							if (md5_local.equals(name) == false) {
								file.delete();
							}
							
							// TODO: remove old one
						}
						else {
							file.delete();
						}
					}
					catch (StringIndexOutOfBoundsException e) { // because the file does not have an . in his path
						file.delete();
					}
				}
			}
		}
		return true;
	}
	
	/**
	 * Cleans working directory and also deletes it if the user hasn't specified a cache directory
	 */
	public void removeWorkingDirectory() {
		if (this.userHasSpecifiedACacheDir) {
			this.cleanWorkingDirectory();
		}
		else {
			Utils.delete(this.workingDirectory);
		}
	}
	
	/**
	 * @return a list of archives (files with extensions .zip or .wool) in the
	 * working, storage, and shared downloads directories as long as they are not null
	 */
	public List<File> getLocalCacheFiles() {
		List<File> files_local = new LinkedList<File>();
		List<File> files = new LinkedList<File>();
		if (this.workingDirectory != null) {
			File[] filesInDirectory = this.workingDirectory.listFiles();
			if (filesInDirectory != null) {
				files.addAll(Arrays.asList(filesInDirectory));
			}
		}
		if (this.storageDirectory != null) {
			File[] filesInDirectory = this.storageDirectory.listFiles();
			if (filesInDirectory != null) {
				files.addAll(Arrays.asList(filesInDirectory));
			}
		}
		if (this.sharedDownloadsDirectory != null) {
			File[] filesInDirectory = this.sharedDownloadsDirectory.listFiles();
			if (filesInDirectory != null) {
				files.addAll(Arrays.asList(filesInDirectory));
			}
		}
		
		for (File file : files) {
			if (file.isFile()) {
				try {
					String extension = file.getName().substring(file.getName().lastIndexOf('.')).toLowerCase();
					String name = file.getName().substring(0, file.getName().length() - 1 * extension.length());
					if (".zip".equals(extension) || ".wool".equals(extension)) {
						// check if the md5 of the file is ok
						String md5_local = Utils.md5(file.getAbsolutePath());
						
						if (md5_local.equals(name)) {
							files_local.add(file);
						}
					}
				}
				catch (StringIndexOutOfBoundsException e) { // because the file does not have an . his path
				}
			}
		}
		return files_local;
	}
	
	/**
	 * 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() {
		ArrayList<String> logs = new ArrayList<>();
		String f = "FSHealth: ";
		logs.add(f + "FilesystemHealthCheck started");
		ArrayList<File> dirsToCheck = new ArrayList<>();
		ArrayList<File> dirsChecked = new ArrayList<>();
		dirsToCheck.add(workingDirectory.getAbsoluteFile());
		if (sharedDownloadsDirectory != null && dirsToCheck.contains(sharedDownloadsDirectory.getAbsoluteFile()) == false) {
			dirsToCheck.add(sharedDownloadsDirectory.getAbsoluteFile());
		}
		if (storageDirectory != null && dirsToCheck.contains(storageDirectory.getAbsoluteFile()) == false) {
			dirsToCheck.add(storageDirectory.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;
	}
	
	/**
	 * @return a string representing the version of the jar or
	 *         {@code 6.0.0} if on error is encountered or the VERSION file doesn't exist
	 */
	private static String getJarVersion() {
		String versionPath = "/VERSION";
		String version = "6.0.0";
		
		InputStream versionStream = Client.class.getResourceAsStream(versionPath);
		if (versionStream != null) {
			try {
				BufferedReader in = new BufferedReader(new InputStreamReader(versionStream));
				version = in.readLine();
			}
			catch (IOException ex) {
				System.err.println("Configuration::getJarVersion error while reading manifest file (" + versionPath + "): " + ex.getMessage());
			}
		}
		else {
			System.err.println("Configuration::getJarVersion Failed to get version file");
		}
		return version;
	}
	
	/**
	 * @return true if operating system is in among the supported platforms
	 *         and is running in a compatible configuration
	 *         false otherwise
	 * @see OS#isSupported()
	 */
	public boolean checkOSisSupported() {
		return OS.getOS() != null && OS.getOS().isSupported();
	}
	
	/**
	 * @return true if operating system is in among the supported platforms
	 *         and if we have data on the cpu
	 *         false otherwise
	 * @see CPU#haveData()
	 */
	public boolean checkCPUisSupported() {
		OS os = OS.getOS();
		if (os != null) {
			CPU cpu = os.getCPU();
			return cpu != null && cpu.haveData();
		}
		return false;
	}
}